Skip to content

Commit 6675760

Browse files
author
Robin Yang
committed
update readme
1 parent 9b9e677 commit 6675760

File tree

6 files changed

+279
-1924
lines changed

6 files changed

+279
-1924
lines changed

‎.vscode/settings.json

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@
33
"editor.detectIndentation": false,
44
"editor.renderWhitespace": "boundary",
55
"files.exclude": {
6-
"**/dist": true,
6+
// "**/dist": true,
77
"**/.rpt2_cache": true
88
},
99
"eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact"],
1010
"editor.formatOnSave": true,
11-
"[javascript]": {
12-
"editor.formatOnSave": false
13-
},
14-
"[javascriptreact]": {
15-
"editor.formatOnSave": false
16-
},
17-
"[typescript]": {
18-
"editor.formatOnSave": false
19-
},
20-
"[typescriptreact]": {
21-
"editor.formatOnSave": false
22-
},
11+
// "[javascript]": {
12+
// "editor.formatOnSave": true
13+
// },
14+
// "[javascriptreact]": {
15+
// "editor.formatOnSave": true
16+
// },
17+
// "[typescript]": {
18+
// "editor.formatOnSave": true
19+
// },
20+
// "[typescriptreact]": {
21+
// "editor.formatOnSave": true
22+
// },
2323
"workbench.editor.enablePreview": false,
2424
"workbench.editor.enablePreviewFromQuickOpen": false,
2525
"editor.codeActionsOnSave": {

‎README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,20 @@ class Display extends Component {
3636

3737
### Props
3838

39-
| Key | Type | Default | Description |
40-
| -------------- | --------------------------- | --------- | ------------------------------------------------------------------------------------------------------ |
41-
| background | string | '#000000' | Hex or rgb() string for the display's background |
42-
| borderColor | string | '#dddddd' | Hex or rgb() string for the color of the border between characters |
43-
| borderWidth | string | '1px' | Any valid CSS width value for the width of the border between characters |
44-
| characterSet | Array of strings (required) | _null_ | The array of characters for the display to flip through |
45-
| characterWidth | string | '1em' | Any valid CSS width value for the width of each character. Useful with non-monospaced fonts |
46-
| fontSize | string | '1em' | Any valid CSS font-size value |
47-
| minLength | number | _null_ | Minimum # of characters in the display |
48-
| padDirection | string | 'left' | If minLength > number of characters currently displayed, append blank characters to left or right side |
49-
| step | number | 200 | Sets the speed (ms) of flips |
50-
| textColor | string | '#dddddd' | Hex or rgb() string for color of the display characters |
51-
| value | string (required) | _null_ | The string of characters to display or flip to |
39+
| Key | Type | Default | Description |
40+
| -------------- | --------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
41+
| background | string | '#000000' | Hex or rgb() string for the display's background |
42+
| borderColor | string | '#dddddd' | Hex or rgb() string for the color of the border between characters |
43+
| borderWidth | string | '1px' | Any valid CSS width value for the width of the border between characters |
44+
| characterSet | Array of strings (required) | _null_ | The array of characters for the display to flip through |
45+
| characterWidth | string | '1em' | Any valid CSS width value for the width of each character. Useful with non-monospaced fonts |
46+
| fontSize | string | '1em' | Any valid CSS font-size value |
47+
| minLength | number | _null_ | Minimum # of characters in the display |
48+
| padDirection | string | 'left' | If minLength > number of characters currently displayed, append blank characters to left or right side |
49+
| step | number | 200 | Sets the speed (ms) of flips |
50+
| textColor | string | '#dddddd' | Hex or rgb() string for color of the display characters |
51+
| value | string (required) | _null_ | The string of characters to display or flip to |
52+
| withSound | boolean or string | _null_ | Optionally load and play a sound with every flip.<br/>Sound duration must be less than or equal to `step` duration.<br/>`true` loads an mp3 I recorded of a single Vestaboard bit flipping |
5253

5354
For `characterSet`, there are three convenience constants that ship with this component (you can see how they might be used in the example):
5455

0 commit comments

Comments
 (0)