Skip to content

Commit 0af6e8c

Browse files
docs: formating documentation
1 parent b71bbc5 commit 0af6e8c

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -44,24 +44,24 @@ function App() {
4444

4545
## 🔧 Props
4646

47-
| Prop | Type | Required | Default | Description |
48-
| ----------------- | ------------------------------------ | -------- | -------- | ----------------------------------------- |
49-
| value | string | Yes\* | - | Controlled text value to display and edit |
50-
| defaultValue | string | No | - | Initial uncontrolled value |
51-
| type | string | No | "text" | HTML input type attribute |
52-
| onChange | ChangeEventHandler<HTMLInputElement> | Yes\* | - | HTML input onChange handler |
53-
| isEditing | boolean | No | false | Control the editing state |
54-
| label | string | No | "" | Label for the input field |
55-
| className | string | No | "" | Container class name |
56-
| editButtonLabel | React.ReactNode | No | "Edit" | Custom edit button label |
57-
| saveButtonLabel | React.ReactNode | No | "Save" | Custom save button label |
58-
| showIcons | boolean | No | false | Toggle button icons visibility |
59-
| iconsOnly | boolean | No | false | Show only icons without text labels |
60-
| editIcon | React.ElementType | No | LuPencil | Custom edit icon component |
61-
| saveIcon | React.ElementType | No | LuCheck | Custom save icon component |
62-
| iconPosition | "left" \| "right" | No | "left" | Position of icons in buttons |
63-
| onEditButtonClick | () => void | No | () => {} | Callback when edit button is clicked |
64-
| onSaveButtonClick | () => void | No | () => {} | Callback when save button is clicked |
47+
| Prop | Type | Required | Default | Description |
48+
| ----------------- | -------------------------------------- | -------- | -------- | ----------------------------------------- |
49+
| value | string | Yes\* | - | Controlled text value to display and edit |
50+
| defaultValue | string | No | - | Initial uncontrolled value |
51+
| type | string | No | "text" | HTML input type attribute |
52+
| onChange | `ChangeEventHandler<HTMLInputElement>` | Yes\* | - | HTML input onChange handler |
53+
| isEditing | boolean | No | false | Control the editing state |
54+
| label | string | No | "" | Label for the input field |
55+
| className | string | No | "" | Container class name |
56+
| editButtonLabel | React.ReactNode | No | "Edit" | Custom edit button label |
57+
| saveButtonLabel | React.ReactNode | No | "Save" | Custom save button label |
58+
| showIcons | boolean | No | false | Toggle button icons visibility |
59+
| iconsOnly | boolean | No | false | Show only icons without text labels |
60+
| editIcon | React.ElementType | No | LuPencil | Custom edit icon component |
61+
| saveIcon | React.ElementType | No | LuCheck | Custom save icon component |
62+
| iconPosition | "left" \| "right" | No | "left" | Position of icons in buttons |
63+
| onEditButtonClick | () => void | No | () => {} | Callback when edit button is clicked |
64+
| onSaveButtonClick | () => void | No | () => {} | Callback when save button is clicked |
6565

6666
\*Either `value` + `onChange` (controlled) or `defaultValue` (uncontrolled) must be provided.
6767

0 commit comments

Comments
 (0)