Skip to content

Commit 3f902db

Browse files
committed
add required props column to readme
1 parent 6a7cb11 commit 3f902db

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ const [ref, { noClamp, clampedText }] = useClampText({
4343

4444
## API Reference
4545

46-
| prop | type | default | description |
47-
| -------- | --------- | ------- | -------------------------------------------------------- |
48-
| text | `string` | | Text you wish to clamp |
49-
| ellipsis | `string` | `'…'` | String displayed after the clamped `text` |
50-
| expanded | `boolean` | `false` | To control whether the string should be truncated or not |
51-
| lines | `number` | `3` | Number of visible lines |
52-
| debounce | `number` | `300` | Time in milliseconds used for debounce |
46+
| prop | type | required | default | description |
47+
| -------- | --------- | -------- | ------- | -------------------------------------------------------- |
48+
| text | `string` | `true` | | Text you wish to clamp |
49+
| ellipsis | `string` | `false` | `'…'` | String displayed after the clamped `text` |
50+
| expanded | `boolean` | `false` | `false` | To control whether the string should be truncated or not |
51+
| lines | `number` | `false` | `3` | Number of visible lines |
52+
| debounce | `number` | `false` | `300` | Time in milliseconds used for debounce |
5353

5454
## Prior Art (packages I ~~copied~~ adapted code from)
5555

0 commit comments

Comments
 (0)