Skip to content

Commit e920264

Browse files
JohudoDmitrii Zuev
Johudo
and
Dmitrii Zuev
authored
docs(FilePreview): updated FilePreview README (#2458)
Co-authored-by: Dmitrii Zuev <[email protected]>
1 parent fb7bb8e commit e920264

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

‎src/components/FilePreview/README.md‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,10 @@ LANDING_BLOCK-->
8383

8484
| Name | Description | Type | Required | Default |
8585
| :------------------ | :--------------------------------------------------------------------------------------------------------------- | :-------------------- | :------: | :-------- |
86-
| file | The File interface provides information about files and allows JavaScript in a web page to access their content. | `File` | yes | |
86+
| file | The File interface provides information about files and allows JavaScript in a web page to access their content. | `File` | ✓ | |
8787
| imageSrc | source for image preview | `string` | | |
8888
| description | Description displayed under the file name | `string` | | |
89+
| selected | Enable or disable selected styles | `boolean` | | `false` |
8990
| className | Class name for the file container | `string` | | |
9091
| onClick | Click handler for the file container | `function` | | |
9192
| [actions](#actions) | An array of interactive actions | `FilePreviewAction[]` | | `[]` |
@@ -95,11 +96,13 @@ LANDING_BLOCK-->
9596

9697
For a file, you can prescribe actions that will be visible when you hover over it.
9798

98-
| Name | Description | Type | Required | Default |
99-
| ---------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | --- |
100-
| id | Action id | `String` | | |
101-
| icon | Action icon | `String` | ✓ | |
102-
| title | Action hint on hover | `String` | ✓ | |
103-
| onClick | Action click handler | `React.MouseEventHandler<HTMLElement>` for default view and `(event: React.MouseEvent<HTMLElement, MouseEvent> or KeyboardEvent) => void` for compact view | | |
104-
| href | Action button href | `String` | | |
105-
| extraProps | Additional action button props | `ButtonHTMLAttributes<HTMLButtonElement> or AnchorHTMLAttributes<HTMLAnchorElement>` (works only for the default desktop view) | | | |
99+
| Name | Description | Type | Required | Default |
100+
| ----------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | :------: | ------- |
101+
| id | Action id | `String` | | |
102+
| icon | Action icon | `React.ReactNode` | ✓ | |
103+
| title | Action hint on hover | `String` | ✓ | |
104+
| onClick | Action click handler | `React.MouseEventHandler<HTMLElement>` for default view and `(event: React.MouseEvent<HTMLElement, MouseEvent> or KeyboardEvent) => void` for compact view | | |
105+
| href | Action button href | `String` | | |
106+
| disabled | Action disabled | `boolean` | | |
107+
| extraProps | Additional action button props | `ButtonButtonProps or ButtonLinkProps` (works only for the default desktop view) | | |
108+
| tooltipExtraProps | Additional action tooltip props | `Omit<ActionTooltipProps, 'title' or 'children'>` (works only for the default desktop view) | | |

0 commit comments

Comments
 (0)