Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: improve readability of classnames and styles properties #520

Merged
merged 2 commits into from Sep 18, 2023
Merged

docs: improve readability of classnames and styles properties #520

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5ff9e6
docs: improve readability of classnames and styles properties
bertyhell Sep 13, 2023
a05752f
replace <br> with <br/> to fix docs build error
bertyhell Sep 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions website/src/docs/index.mdx
View file
Open in desktop
Expand Up @@ -192,8 +192,8 @@ By default, the Modal will be rendered at the end of the html body tag. If you w
| **focusTrapped** | `boolean` | true | When the modal is open, trap focus within it. |
| **initialFocusRef** | `React.RefElement<HTMLElement>` | undefined | Sets focus on this specific element when modal opens if focus trap is used. |
| **container** | `Element` | | You can specify a container prop which should be of type `Element`. The portal will be rendered inside that element. The default behavior will create a div node and render it at the at the end of document.body. |
| **classNames** | `{ root?: string; overlay?: string; overlayAnimationIn?: string; overlayAnimationOut?: string; modal?: string; modalAnimationIn?: string; modalAnimationOut?: string; closeButton?: string; closeIcon?: string; }` | | An object containing classNames to style the modal. |
| **styles** | `{ root?: React.CSSProperties; overlay?: React.CSSProperties; overlay?: React.CSSProperties; modalContainer?: React.CSSProperties; modal?: React.CSSProperties; closeButton?: React.CSSProperties; closeIcon?: React.CSSProperties; }` | | An object containing the styles objects to style the modal. |
| **classNames** | `{`<br/>`root?: string;`<br/>`overlay?: string;`<br/>`overlayAnimationIn?: string;`<br/>`overlayAnimationOut?: string;`<br/>`modal?: string;`<br/>`modalAnimationIn?: string;`<br/>`modalAnimationOut?: string;`<br/>`closeButton?: string;`<br/>`closeIcon?: string;`<br/>`}` | | An object containing classNames to style the modal. |
| **styles** | `{`<br/>`root?: React.CSSProperties;`<br/>`overlay?: React.CSSProperties;`<br/>`overlay?: React.CSSProperties;`<br/>`modalContainer?: React.CSSProperties;`<br/>`modal?: React.CSSProperties;`<br/>`closeButton?: React.CSSProperties;`<br/>`closeIcon?: React.CSSProperties;`<br/>`}` | | An object containing the styles objects to style the modal. |
| **animationDuration** | `number` | 300 | Animation duration in milliseconds. |
| **role** | `string` | "dialog" | ARIA role for modal |
| **ref** | `React.RefElement<HTMLDivElement>` | undefined | Ref for modal dialog element |
Expand Down