-
Notifications
You must be signed in to change notification settings - Fork 592
Commit
- Loading branch information
There are no files selected for viewing
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{"meta":"<h2 id=\"Guide\">Guide <a class=\"header-anchor scroll-count-item\" href=\"#Guide\" data-scroll-id=\"Guide\">#</a></h2>\n<h3 id=\"When To Use\">When to Use <a class=\"header-anchor scroll-count-item\" href=\"#When To Use\" data-scroll-id=\"When To Use\">#</a></h3>\n<p>The Affix component allows an element to become affixed (locked) to an area on the page. This is offten used with navigation menus or social icon buttons, to make them "stick" at specific area while scrolling up and down the page.</p>\n","api":"<h2 id=\"API\">API <a class=\"header-anchor scroll-count-item\" href=\"#API\" data-scroll-id=\"API\">#</a></h2>\n<h3 id=\"Affix\">Affix <a class=\"header-anchor scroll-count-item\" href=\"#Affix\" data-scroll-id=\"Affix\">#</a></h3>\n<table>\n<thead>\n<tr>\n<th>Param</th>\n<th>Description</th>\n<th>Type</th>\n<th>Default Value</th>\n<th>Required</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>container</td>\n<td>The container for listening scroll events</td>\n<td>() => Element | Window</td>\n<td>() => window</td>\n<td></td>\n</tr>\n<tr>\n<td>offsetTop</td>\n<td>Offset from top when event triggers</td>\n<td>number</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>offsetBottom</td>\n<td>Offset from bottom when event triggers</td>\n<td>number</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>onAffix</td>\n<td>Callback when affix event triggers<br><br><strong>signature</strong>:<br><strong>params</strong>:<br><em>affixed</em>: If element is affixed</td>\n<td>(affixed: boolean) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>useAbsolute</td>\n<td>Enable absolute position</td>\n<td>boolean</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>className</td>\n<td>-</td>\n<td>string</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>style</td>\n<td>-</td>\n<td>React.CSSProperties</td>\n<td>-</td>\n<td></td>\n</tr>\n</tbody>\n</table>\n"} |
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{"meta":"<h2 id=\"Guide\">Guide <a class=\"header-anchor scroll-count-item\" href=\"#Guide\" data-scroll-id=\"Guide\">#</a></h2>\n<h3 id=\"When To Use\">When To Use <a class=\"header-anchor scroll-count-item\" href=\"#When To Use\" data-scroll-id=\"When To Use\">#</a></h3>\n<p>Need to customize animation.</p>\n","api":"<h2 id=\"API\">API <a class=\"header-anchor scroll-count-item\" href=\"#API\" data-scroll-id=\"API\">#</a></h2>\n<h3 id=\"Animate\">Animate <a class=\"header-anchor scroll-count-item\" href=\"#Animate\" data-scroll-id=\"Animate\">#</a></h3>\n<table>\n<thead>\n<tr>\n<th>Param</th>\n<th>Description</th>\n<th>Type</th>\n<th>Default Value</th>\n<th>Required</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>animation</td>\n<td>The animation className</td>\n<td>string | Partial<Record<'appear' | 'enter' | 'leave', string>></td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>animationAppear</td>\n<td>Whether to execute animation on the first mount</td>\n<td>boolean</td>\n<td>true</td>\n<td></td>\n</tr>\n<tr>\n<td>component</td>\n<td>The tag of the wrapper</td>\n<td>React.ElementType</td>\n<td>'div'</td>\n<td></td>\n</tr>\n<tr>\n<td>singleMode</td>\n<td>Whether to only have a single child</td>\n<td>boolean</td>\n<td>true</td>\n<td></td>\n</tr>\n<tr>\n<td>beforeAppear</td>\n<td>Callback fired before the "entering" status of the first mount is applied</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>onAppear</td>\n<td>Callback fired after the "entering" status of the first mount is applied</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>afterAppear</td>\n<td>Callback fired after the "entered" status of the first mount is applied</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>beforeEnter</td>\n<td>Callback fired before the "entering" status is applied</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>onEnter</td>\n<td>Callback fired after the "entering" status is applied</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>afterEnter</td>\n<td>Callback fired after the "entered" status is applied</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>beforeLeave</td>\n<td>Callback fired before the "exiting" status is applied</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>onLeave</td>\n<td>Callback fired after the leave stage</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>afterLeave</td>\n<td>Callback fired after the leave stage</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n</tbody>\n</table>\n<h3 id=\"Animate Expand\">Animate.Expand <a class=\"header-anchor scroll-count-item\" href=\"#Animate Expand\" data-scroll-id=\"Animate Expand\">#</a></h3>\n<table>\n<thead>\n<tr>\n<th>Param</th>\n<th>Description</th>\n<th>Type</th>\n<th>Default Value</th>\n<th>Required</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>animation</td>\n<td>The animation className</td>\n<td>string | Partial<Record<'appear' | 'enter' | 'leave', string>></td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>beforeEnter</td>\n<td>Callback fired before the "entering" status is applied</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>onEnter</td>\n<td>Callback fired after the "entering" status is applied</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>afterEnter</td>\n<td>Callback fired after the "entered" status is applied</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>beforeLeave</td>\n<td>Callback fired before the "exiting" status is applied</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>onLeave</td>\n<td>Callback fired after the "exiting" status is applied</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>afterLeave</td>\n<td>Callback fired after the "exited" status is applied</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n</tbody>\n</table>\n<h3 id=\"Animate Overlay Animate\">Animate.OverlayAnimate <a class=\"header-anchor scroll-count-item\" href=\"#Animate Overlay Animate\" data-scroll-id=\"Animate Overlay Animate\">#</a></h3>\n<table>\n<thead>\n<tr>\n<th>Param</th>\n<th>Description</th>\n<th>Type</th>\n<th>Default Value</th>\n<th>Required</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>animation</td>\n<td>The animation className</td>\n<td>string | false | Record<'in' | 'out', string></td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>visible</td>\n<td>Show the component; triggers the enter or exit states</td>\n<td>boolean</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>children</td>\n<td>The element to be wrapped</td>\n<td>ReactElement</td>\n<td>-</td>\n<td>yes</td>\n</tr>\n<tr>\n<td>timeout</td>\n<td>The duration of the transition.</td>\n<td>| number<br> | { appear?: number | undefined; enter?: number | undefined; exit?: number | undefined }</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>style</td>\n<td>The style of the child element</td>\n<td>React.CSSProperties</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>mountOnEnter</td>\n<td>"lazy mount" the component on the first <code>in={true}</code></td>\n<td>boolean</td>\n<td>false</td>\n<td></td>\n</tr>\n<tr>\n<td>unmountOnExit</td>\n<td>"lazy unmount" the component on the first <code>in={false}</code></td>\n<td>boolean</td>\n<td>false</td>\n<td></td>\n</tr>\n<tr>\n<td>onEnter</td>\n<td>Callback fired before the "entering" status is applied.<br><br><strong>signature</strong>:<br><strong>params</strong>:<br><em>isAppearing</em>: IsAppearing</td>\n<td>(node: HTMLElement, isAppearing: boolean) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>onEntering</td>\n<td>Callback fired after the "entering" status is applied.<br><br><strong>signature</strong>:<br><strong>params</strong>:<br><em>isAppearing</em>: IsAppearing</td>\n<td>(node: HTMLElement, isAppearing: boolean) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>onEntered</td>\n<td>Callback fired after the "entered" status is applied.<br><br><strong>signature</strong>:<br><strong>params</strong>:<br><em>isAppearing</em>: IsAppearing</td>\n<td>(node: HTMLElement, isAppearing: boolean) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>onExit</td>\n<td>Callback fired before the "exiting" status is applied.</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>onExiting</td>\n<td>Callback fired after the "exiting" status is applied.</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>onExited</td>\n<td>Callback fired after the "exited" status is applied.</td>\n<td>(node: HTMLElement) => void</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>appear</td>\n<td>Transition on the first mount.</td>\n<td>boolean</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>enter</td>\n<td>Enable or disable enter transitions.</td>\n<td>boolean</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>exit</td>\n<td>Enable or disable exit transitions.</td>\n<td>boolean</td>\n<td>-</td>\n<td></td>\n</tr>\n</tbody>\n</table>\n<h2 id=\"Animation List\">Animation List <a class=\"header-anchor scroll-count-item\" href=\"#Animation List\" data-scroll-id=\"Animation List\">#</a></h2>\n<table>\n<thead>\n<tr>\n<th>In</th>\n<th>Out</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>fadeIn</td>\n<td>fadeOut</td>\n</tr>\n<tr>\n<td>fadeInDown</td>\n<td>fadeOutDown</td>\n</tr>\n<tr>\n<td>fadeInLeft</td>\n<td>fadeOutLeft</td>\n</tr>\n<tr>\n<td>fadeInRight</td>\n<td>fadeOutRight</td>\n</tr>\n<tr>\n<td>fadeInUp</td>\n<td>fadeOutUp</td>\n</tr>\n<tr>\n<td>slideInDown</td>\n<td>slideOutUp</td>\n</tr>\n<tr>\n<td>slideInLeft</td>\n<td>slideOutLeft</td>\n</tr>\n<tr>\n<td>slideInRight</td>\n<td>slideOutRight</td>\n</tr>\n<tr>\n<td>slideInUp</td>\n<td>slideOutDown</td>\n</tr>\n<tr>\n<td>zoomIn</td>\n<td>zoomOut</td>\n</tr>\n<tr>\n<td>expandInDown</td>\n<td>expandOutUp</td>\n</tr>\n<tr>\n<td>expandInUp</td>\n<td>expandOutDown</td>\n</tr>\n<tr>\n<td>pulse</td>\n<td></td>\n</tr>\n</tbody>\n</table>\n"} |
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{"meta":"<h2 id=\"Develop Guide\">Develop Guide <a class=\"header-anchor scroll-count-item\" href=\"#Develop Guide\" data-scroll-id=\"Develop Guide\">#</a></h2>\n<p>1.19.0+ supported</p>\n<h3 id=\"When To Use\">When to Use <a class=\"header-anchor scroll-count-item\" href=\"#When To Use\" data-scroll-id=\"When To Use\">#</a></h3>\n<p>Avatars can be used to represent people or objects. It supports images, Icons, or letters.</p>\n","api":"<h2 id=\"API\">API <a class=\"header-anchor scroll-count-item\" href=\"#API\" data-scroll-id=\"API\">#</a></h2>\n<h3 id=\"Avatar\">Avatar <a class=\"header-anchor scroll-count-item\" href=\"#Avatar\" data-scroll-id=\"Avatar\">#</a></h3>\n<table>\n<thead>\n<tr>\n<th>Param</th>\n<th>Description</th>\n<th>Type</th>\n<th>Default Value</th>\n<th>Required</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>children</td>\n<td>Children node list</td>\n<td>React.ReactNode</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>size</td>\n<td>The size of the avatar</td>\n<td>'small' | 'medium' | 'large' | number</td>\n<td>'medium'</td>\n<td></td>\n</tr>\n<tr>\n<td>shape</td>\n<td>The shape of the avatar</td>\n<td>'circle' | 'square'</td>\n<td>'circle'</td>\n<td></td>\n</tr>\n<tr>\n<td>icon</td>\n<td>The icon type of the icon avatar, can be set to the <code>type</code> or <code>ReactElement</code> of Icon</td>\n<td>React.ReactElement | string</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>src</td>\n<td>The resource address of the image avatar</td>\n<td>string</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>onError</td>\n<td>The event of the image loading failure, returning false will close the component's default fallback behavior</td>\n<td>() => boolean</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>alt</td>\n<td>The alt replacement text when the image cannot be displayed</td>\n<td>string</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>srcSet</td>\n<td>The responsive resource address of the image avatar</td>\n<td>string</td>\n<td>-</td>\n<td></td>\n</tr>\n</tbody>\n</table>\n"} |
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{"meta":"<h2 id=\"Develop Guide\">Develop Guide <a class=\"header-anchor scroll-count-item\" href=\"#Develop Guide\" data-scroll-id=\"Develop Guide\">#</a></h2>\n<h3 id=\"When To Use\">When to Use <a class=\"header-anchor scroll-count-item\" href=\"#When To Use\" data-scroll-id=\"When To Use\">#</a></h3>\n<p>When we receive a new message, or our app/plugin/module should be update or upgrade.</p>\n<h3 id=\"Accessibility\">Accessibility <a class=\"header-anchor scroll-count-item\" href=\"#Accessibility\" data-scroll-id=\"Accessibility\">#</a></h3>\n<p>You can add class as below, so that messages will not appear on pages, but can be read by screen reader.\n<code><span className="next-sr-only">unread messages</span></code></p>\n","api":"<h2 id=\"API\">API <a class=\"header-anchor scroll-count-item\" href=\"#API\" data-scroll-id=\"API\">#</a></h2>\n<h3 id=\"Badge\">Badge <a class=\"header-anchor scroll-count-item\" href=\"#Badge\" data-scroll-id=\"Badge\">#</a></h3>\n<table>\n<thead>\n<tr>\n<th>Param</th>\n<th>Description</th>\n<th>Type</th>\n<th>Default Value</th>\n<th>Required</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>children</td>\n<td>Content of Badge based on</td>\n<td>React.ReactNode</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>count</td>\n<td>Number to display, display overflowCount+ when count is greater than overflowCount, display none when count equal to 0</td>\n<td>number | string</td>\n<td>0</td>\n<td></td>\n</tr>\n<tr>\n<td>content</td>\n<td>Customized node content</td>\n<td>React.ReactNode</td>\n<td>-</td>\n<td></td>\n</tr>\n<tr>\n<td>overflowCount</td>\n<td>Max number to display</td>\n<td>number | string</td>\n<td>99</td>\n<td></td>\n</tr>\n<tr>\n<td>dot</td>\n<td>Display a red dot, not a number</td>\n<td>boolean</td>\n<td>false</td>\n<td></td>\n</tr>\n<tr>\n<td>showZero</td>\n<td>Whether to show count when count is 0</td>\n<td>boolean</td>\n<td>false</td>\n<td></td>\n</tr>\n</tbody>\n</table>\n"} |
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.