@pexip/components 20.0.0 → 20.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +26 -0
- package/api-docs/README.mdx +1 -0
- package/api-docs/functions/announce.mdx +1 -1
- package/api-docs/functions/onEnter.mdx +3 -3
- package/api-docs/functions/sizeToPadding.mdx +16 -6
- package/api-docs/functions/useBreakpointChange.mdx +1 -1
- package/api-docs/functions/useFocusFrom.mdx +2 -2
- package/api-docs/functions/useFocusFromOpened.mdx +1 -1
- package/api-docs/functions/useGroupedPagesNav.mdx +2 -2
- package/api-docs/functions/useInput.mdx +4 -2
- package/api-docs/functions/useModal.mdx +2 -2
- package/api-docs/functions/useModalHandle.mdx +1 -1
- package/api-docs/functions/useModalWithoutPreventScroll.mdx +2 -2
- package/api-docs/functions/useMultistepIndicator.mdx +24 -8
- package/api-docs/functions/useOutOfViewNavigation.mdx +4 -4
- package/api-docs/functions/useScrollIntoView.mdx +3 -3
- package/api-docs/functions/useTabs.mdx +1 -1
- package/api-docs/functions/withColorScheme.mdx +3 -3
- package/api-docs/functions/withTabName.mdx +2 -2
- package/api-docs/functions/withTransition.mdx +6 -4
- package/api-docs/interfaces/FullSizeWindowCommonProps.mdx +4 -4
- package/api-docs/interfaces/IconCollection.mdx +4 -0
- package/api-docs/interfaces/IconSource.mdx +3 -3
- package/api-docs/interfaces/LoadingBoxProps.mdx +5 -3
- package/api-docs/interfaces/ModalHandle.mdx +1 -1
- package/api-docs/interfaces/MultistepItem.mdx +1 -1
- package/api-docs/interfaces/StatCardRowData.mdx +5 -5
- package/api-docs/interfaces/ToastProps.mdx +3 -3
- package/api-docs/interfaces/VideoHandle.mdx +2 -2
- package/api-docs/interfaces/WithTransitionProps.mdx +1 -0
- package/api-docs/type-aliases/ActivityCardAction.mdx +1 -1
- package/api-docs/type-aliases/AriaMenuItem.mdx +4 -1
- package/api-docs/type-aliases/AriaMenuProps.mdx +1 -1
- package/api-docs/type-aliases/BreadcrumbItem.mdx +1 -1
- package/api-docs/type-aliases/ClickEventHandler.mdx +1 -1
- package/api-docs/type-aliases/MenuAction.mdx +1 -1
- package/api-docs/type-aliases/MenuItem.mdx +3 -3
- package/api-docs/type-aliases/MultiselectOption.mdx +1 -1
- package/api-docs/type-aliases/NotificationToastMessage.mdx +1 -1
- package/api-docs/type-aliases/NotificationTooltipPosition.mdx +3 -1
- package/api-docs/type-aliases/NotificationTooltipProps.mdx +3 -0
- package/api-docs/type-aliases/Option.mdx +1 -1
- package/api-docs/type-aliases/SelectProps.mdx +3 -3
- package/api-docs/type-aliases/TagItem.mdx +2 -2
- package/api-docs/variables/Select.mdx +2 -2
- package/api-docs/variables/Toast.mdx +3 -1
- package/design-tokens/variables.legacy.scss +8 -0
- package/dist/components-no-global-styles.css +1 -1
- package/dist/components.cjs +2 -2
- package/dist/components.css +1 -1
- package/dist/components.js +4124 -4093
- package/dist/types/design-tokens/generated/Icons.d.ts +4 -0
- package/dist/types/design-tokens/generated/Icons.d.ts.map +1 -1
- package/dist/types/src/components/elements/Draggable/Draggable.view.d.ts.map +1 -1
- package/dist/types/src/components/elements/Tooltip/NotificationTooltip.d.ts +1 -1
- package/dist/types/src/components/elements/Tooltip/NotificationTooltip.d.ts.map +1 -1
- package/dist/types/src/components/modules/AriaMenu/AriaMenu.types.d.ts +12 -0
- package/dist/types/src/components/modules/AriaMenu/AriaMenu.types.d.ts.map +1 -1
- package/dist/types/src/components/modules/AriaMenu/InnerAriaMenuItem.d.ts.map +1 -1
- package/dist/types/src/components/modules/CondensedTabs/CondensedTabs.view.d.ts +1 -0
- package/dist/types/src/components/modules/CondensedTabs/CondensedTabs.view.d.ts.map +1 -1
- package/dist/types/src/components/modules/Menu/Menu.d.ts.map +1 -1
- package/dist/types/src/components/modules/Sheet/Sheet.d.ts +2 -0
- package/dist/types/src/components/modules/Sheet/Sheet.d.ts.map +1 -1
- package/dist/types/src/components/modules/TransitionContainer/withTransition.d.ts +1 -0
- package/dist/types/src/components/modules/TransitionContainer/withTransition.d.ts.map +1 -1
- package/dist/types/src/exports.d.ts +1 -0
- package/dist/types/src/exports.d.ts.map +1 -1
- package/package.json +5 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,31 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 20.1.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- d7432f8: Add `variant` prop to `CondensedTabs` with `underline` style support.
|
|
8
|
+
Add `isFullWidth` and `noMargin` props to `Sheet`.
|
|
9
|
+
- 300946c: Adds `className` optional prop to `withTransition`
|
|
10
|
+
- c064e2d: - Add `withTopDivider` / `withBottomDivider` props to `AriaMenuItem`
|
|
11
|
+
for rendering dividers around menu items
|
|
12
|
+
- Move Menu section divider inside `<List>` for consistent padding with menu
|
|
13
|
+
items
|
|
14
|
+
- Add `role="separator"` to dividers for accessibility
|
|
15
|
+
- Update divider color tokens (`neutral-30` / `neutral-80`), preserve old
|
|
16
|
+
values in `variables.legacy.scss`
|
|
17
|
+
- Add `WithDividers` story for AriaMenu
|
|
18
|
+
- fe02b23: Adds 'right' and 'left' position to `NotificationTooltip`
|
|
19
|
+
|
|
20
|
+
### Patch Changes
|
|
21
|
+
|
|
22
|
+
- 15954c9: Lint
|
|
23
|
+
- 6732861: Fix issue with the css overrides.
|
|
24
|
+
- Updated dependencies [44ad859]
|
|
25
|
+
- Updated dependencies [514c523]
|
|
26
|
+
- @pexip/utils@17.4.0
|
|
27
|
+
- @pexip/hooks@21.0.8
|
|
28
|
+
|
|
3
29
|
## 20.0.0
|
|
4
30
|
|
|
5
31
|
### Major Changes
|
package/api-docs/README.mdx
CHANGED
|
@@ -73,6 +73,7 @@ import '@pexip/components/dist/index.css';
|
|
|
73
73
|
| [TextProps](type-aliases/TextProps.mdx) | - |
|
|
74
74
|
| [TextLinkProps](type-aliases/TextLinkProps.mdx) | - |
|
|
75
75
|
| [NotificationTooltipPosition](type-aliases/NotificationTooltipPosition.mdx) | - |
|
|
76
|
+
| [NotificationTooltipProps](type-aliases/NotificationTooltipProps.mdx) | - |
|
|
76
77
|
| [OverlayOpacity](type-aliases/OverlayOpacity.mdx) | - |
|
|
77
78
|
| [FullSizeWindowColorBackgroundProps](type-aliases/FullSizeWindowColorBackgroundProps.mdx) | - |
|
|
78
79
|
| [FullSizeWindowImageBackgroundProps](type-aliases/FullSizeWindowImageBackgroundProps.mdx) | - |
|
|
@@ -13,7 +13,7 @@ Announcer needs to be mounted in the application for this to work.
|
|
|
13
13
|
| Parameter | Type | Default value | Description |
|
|
14
14
|
| ------ | ------ | ------ | ------ |
|
|
15
15
|
| `message` | `ReactNode` | `undefined` | The message to announce. |
|
|
16
|
-
| `politeness` | `"assertive"
|
|
16
|
+
| `politeness` | `"assertive" \| "polite"` | `'polite'` | The politeness level of the announcement. |
|
|
17
17
|
| `timeout` | `number` | `5000` | The time in milliseconds util the message is removed from area-live region. |
|
|
18
18
|
|
|
19
19
|
## Returns
|
|
@@ -6,8 +6,8 @@ function onEnter<E, T>(callback): (e) => void;
|
|
|
6
6
|
|
|
7
7
|
| Type Parameter |
|
|
8
8
|
| ------ |
|
|
9
|
-
| `E
|
|
10
|
-
| `T
|
|
9
|
+
| `E extends HTMLElement` |
|
|
10
|
+
| `T extends (e) => void` |
|
|
11
11
|
|
|
12
12
|
## Parameters
|
|
13
13
|
|
|
@@ -25,7 +25,7 @@ function onEnter<E, T>(callback): (e) => void;
|
|
|
25
25
|
|
|
26
26
|
| Parameter | Type |
|
|
27
27
|
| ------ | ------ |
|
|
28
|
-
| `e` | `KeyboardEvent
|
|
28
|
+
| `e` | `KeyboardEvent<E>` |
|
|
29
29
|
|
|
30
30
|
### Returns
|
|
31
31
|
|
|
@@ -11,12 +11,22 @@ function sizeToPadding(t):
|
|
|
11
11
|
|
|
12
12
|
| Parameter | Type |
|
|
13
13
|
| ------ | ------ |
|
|
14
|
-
| `t` | `"small"
|
|
14
|
+
| `t` | `"small" \| "medium" \| "compact" \| "large" \| "none"` |
|
|
15
15
|
|
|
16
16
|
## Returns
|
|
17
17
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
18
|
+
```ts
|
|
19
|
+
| "compactPadding"
|
|
20
|
+
```
|
|
21
|
+
```ts
|
|
22
|
+
| "largePadding"
|
|
23
|
+
```
|
|
24
|
+
```ts
|
|
25
|
+
| "mediumPadding"
|
|
26
|
+
```
|
|
27
|
+
```ts
|
|
28
|
+
| "nonePadding"
|
|
29
|
+
```
|
|
30
|
+
```ts
|
|
31
|
+
| "smallPadding"
|
|
32
|
+
```
|
|
@@ -11,7 +11,7 @@ will be focused on the next tab.
|
|
|
11
11
|
|
|
12
12
|
| Parameter | Type | Description |
|
|
13
13
|
| ------ | ------ | ------ |
|
|
14
|
-
| `element` | `HTMLElement
|
|
14
|
+
| `element` | `HTMLElement \| null` | element which focus point should start from |
|
|
15
15
|
|
|
16
16
|
## Returns
|
|
17
17
|
|
|
@@ -21,4 +21,4 @@ focusFrom function, when called sets the focus point to the given element
|
|
|
21
21
|
|
|
22
22
|
| Name | Type |
|
|
23
23
|
| ------ | ------ |
|
|
24
|
-
| `focusFrom()` | () =>
|
|
24
|
+
| `focusFrom()` | `() => void` |
|
|
@@ -12,7 +12,7 @@ element inside the container element.
|
|
|
12
12
|
|
|
13
13
|
| Parameter | Type | Description |
|
|
14
14
|
| ------ | ------ | ------ |
|
|
15
|
-
| `element` | `HTMLElement
|
|
15
|
+
| `element` | `HTMLElement \| null` | element which focus point should start from |
|
|
16
16
|
| `isOpen` | `boolean` | when isOpen is true the element will get the focus point |
|
|
17
17
|
|
|
18
18
|
## Returns
|
|
@@ -6,11 +6,11 @@ function useGroupedPagesNav(__namedParameters): GroupedPageNav[];
|
|
|
6
6
|
|
|
7
7
|
| Parameter | Type |
|
|
8
8
|
| ------ | ------ |
|
|
9
|
-
| `__namedParameters` |
|
|
9
|
+
| `__namedParameters` | `{ groupChunkSize?: number; pageIndex: number; totalPagesCount: number; }` |
|
|
10
10
|
| `__namedParameters.groupChunkSize?` | `number` |
|
|
11
11
|
| `__namedParameters.pageIndex` | `number` |
|
|
12
12
|
| `__namedParameters.totalPagesCount` | `number` |
|
|
13
13
|
|
|
14
14
|
## Returns
|
|
15
15
|
|
|
16
|
-
`GroupedPageNav
|
|
16
|
+
`GroupedPageNav[]`
|
|
@@ -6,8 +6,10 @@ function useInput(props): [string, Omit<Omit<DetailedHTMLProps<InputHTMLAttribut
|
|
|
6
6
|
|
|
7
7
|
| Parameter | Type |
|
|
8
8
|
| ------ | ------ |
|
|
9
|
-
| `props` | `Omit
|
|
9
|
+
| `props` | `Omit<Omit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "disabled"> & object, "ref"> & RefAttributes<Pick<HTMLInputElement, "focus">>` |
|
|
10
10
|
|
|
11
11
|
## Returns
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
```ts
|
|
14
|
+
[string, Omit<Omit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "disabled"> & object, "ref"> & RefAttributes<Pick<HTMLInputElement, "focus">>]
|
|
15
|
+
```
|
|
@@ -14,5 +14,5 @@ function useModal(isOpen): object;
|
|
|
14
14
|
|
|
15
15
|
| Name | Type |
|
|
16
16
|
| ------ | ------ |
|
|
17
|
-
| `ref` | `RefObject
|
|
18
|
-
| `modalProps` | `DOMAttributes
|
|
17
|
+
| `ref` | `RefObject<HTMLDivElement \| null>` |
|
|
18
|
+
| `modalProps` | `DOMAttributes<FocusableElement>` |
|
|
@@ -20,5 +20,5 @@ causes the virtual keyboard to cover focused inputs.
|
|
|
20
20
|
|
|
21
21
|
| Name | Type | Default value |
|
|
22
22
|
| ------ | ------ | ------ |
|
|
23
|
-
| `ref` | `RefObject
|
|
24
|
-
| `modalProps` | `DOMAttributes
|
|
23
|
+
| `ref` | `RefObject<HTMLDivElement \| null>` | - |
|
|
24
|
+
| `modalProps` | `DOMAttributes<FocusableElement>` | `overlayProps` |
|
|
@@ -34,12 +34,28 @@ readonly \[\{
|
|
|
34
34
|
`prevStepsCompleted`: `boolean`;
|
|
35
35
|
`steps`: [`MultistepItem`](../interfaces/MultistepItem.mdx)[];
|
|
36
36
|
\}, \{
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
37
|
+
```ts
|
|
38
|
+
moveToStep: (stepIndex, __namedParameters) => void;
|
|
39
|
+
```
|
|
40
|
+
```ts
|
|
41
|
+
resetAllSteps: () => void;
|
|
42
|
+
```
|
|
43
|
+
```ts
|
|
44
|
+
resetStep: (stepIndex) => void;
|
|
45
|
+
```
|
|
46
|
+
```ts
|
|
47
|
+
updateStepActive: (stepIndex, isActive) => void;
|
|
48
|
+
```
|
|
49
|
+
```ts
|
|
50
|
+
updateStepCompleted: (stepIndex, __namedParameters) => void;
|
|
51
|
+
```
|
|
52
|
+
```ts
|
|
53
|
+
updateStepFailed: (stepIndex, __namedParameters) => void;
|
|
54
|
+
```
|
|
55
|
+
```ts
|
|
56
|
+
updateStepDisabled: (stepIndex, isDisabled) => void;
|
|
57
|
+
```
|
|
58
|
+
```ts
|
|
59
|
+
updateStepLeave: (stepIndex, __namedParameters) => void;
|
|
60
|
+
```
|
|
45
61
|
\}\]
|
|
@@ -6,10 +6,10 @@ function useOutOfViewNavigation(__namedParameters): object;
|
|
|
6
6
|
|
|
7
7
|
| Parameter | Type |
|
|
8
8
|
| ------ | ------ |
|
|
9
|
-
| `__namedParameters` |
|
|
9
|
+
| `__namedParameters` | `{ isDisabled?: boolean; content: ReactElement; root: HTMLElement \| null; moveBy?: number; containerClassName?: string; }` |
|
|
10
10
|
| `__namedParameters.isDisabled?` | `boolean` |
|
|
11
11
|
| `__namedParameters.content` | `ReactElement` |
|
|
12
|
-
| `__namedParameters.root` | `HTMLElement
|
|
12
|
+
| `__namedParameters.root` | `HTMLElement \| null` |
|
|
13
13
|
| `__namedParameters.moveBy?` | `number` |
|
|
14
14
|
| `__namedParameters.containerClassName?` | `string` |
|
|
15
15
|
|
|
@@ -20,6 +20,6 @@ function useOutOfViewNavigation(__namedParameters): object;
|
|
|
20
20
|
| Name | Type |
|
|
21
21
|
| ------ | ------ |
|
|
22
22
|
| `navigationView` | `Element` |
|
|
23
|
-
| `moveLeft` | () =>
|
|
24
|
-
| `moveRight` | () =>
|
|
23
|
+
| `moveLeft` | `() => void \| undefined` |
|
|
24
|
+
| `moveRight` | `() => void \| undefined` |
|
|
25
25
|
| `hasOverflowingContent` | `boolean` |
|
|
@@ -6,10 +6,10 @@ function useScrollIntoView(element, options): () => void;
|
|
|
6
6
|
|
|
7
7
|
| Parameter | Type |
|
|
8
8
|
| ------ | ------ |
|
|
9
|
-
| `element` | `RefObject
|
|
10
|
-
| `options` |
|
|
9
|
+
| `element` | `RefObject<HTMLElement \| null>` |
|
|
10
|
+
| `options` | `{ delay?: number; scrollIntoViewOptions?: Partial<ScrollIntoViewOptions>; }` |
|
|
11
11
|
| `options.delay?` | `number` |
|
|
12
|
-
| `options.scrollIntoViewOptions?` | `Partial
|
|
12
|
+
| `options.scrollIntoViewOptions?` | `Partial<ScrollIntoViewOptions>` |
|
|
13
13
|
|
|
14
14
|
## Returns
|
|
15
15
|
|
|
@@ -6,14 +6,14 @@ function withColorScheme<P>(Component, colorScheme): (props) => Element;
|
|
|
6
6
|
|
|
7
7
|
| Type Parameter |
|
|
8
8
|
| ------ |
|
|
9
|
-
| `P
|
|
9
|
+
| `P extends object` |
|
|
10
10
|
|
|
11
11
|
## Parameters
|
|
12
12
|
|
|
13
13
|
| Parameter | Type |
|
|
14
14
|
| ------ | ------ |
|
|
15
|
-
| `Component` | `ComponentType
|
|
16
|
-
| `colorScheme` | `"dark"
|
|
15
|
+
| `Component` | `ComponentType<P>` |
|
|
16
|
+
| `colorScheme` | `"dark" \| "light"` |
|
|
17
17
|
|
|
18
18
|
## Returns
|
|
19
19
|
|
|
@@ -12,7 +12,7 @@ function withTabName<P>(Component, componentProps?): (props) => Element;
|
|
|
12
12
|
|
|
13
13
|
| Parameter | Type |
|
|
14
14
|
| ------ | ------ |
|
|
15
|
-
| `Component` | `ComponentType
|
|
15
|
+
| `Component` | `ComponentType<P>` |
|
|
16
16
|
| `componentProps?` | `P` |
|
|
17
17
|
|
|
18
18
|
## Returns
|
|
@@ -25,7 +25,7 @@ function withTabName<P>(Component, componentProps?): (props) => Element;
|
|
|
25
25
|
|
|
26
26
|
| Parameter | Type |
|
|
27
27
|
| ------ | ------ |
|
|
28
|
-
| `props` | `P` & `ClassAttributes
|
|
28
|
+
| `props` | `P` & `ClassAttributes<HTMLButtonElement>` & `ButtonHTMLAttributes<HTMLButtonElement>` |
|
|
29
29
|
|
|
30
30
|
### Returns
|
|
31
31
|
|
|
@@ -9,15 +9,15 @@ function withTransition<P>(
|
|
|
9
9
|
|
|
10
10
|
| Type Parameter |
|
|
11
11
|
| ------ |
|
|
12
|
-
| `P
|
|
12
|
+
| `P extends object` |
|
|
13
13
|
|
|
14
14
|
## Parameters
|
|
15
15
|
|
|
16
16
|
| Parameter | Type | Default value |
|
|
17
17
|
| ------ | ------ | ------ |
|
|
18
|
-
| `Component` | `ComponentType
|
|
18
|
+
| `Component` | `ComponentType<P>` | `undefined` |
|
|
19
19
|
| `timeout` | `number` | `undefined` |
|
|
20
|
-
| `stateAfterTransition` | `"hide"
|
|
20
|
+
| `stateAfterTransition` | `"hide" \| "unmount"` | `'unmount'` |
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
@@ -33,4 +33,6 @@ function withTransition<P>(
|
|
|
33
33
|
|
|
34
34
|
### Returns
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
```ts
|
|
37
|
+
Element | null
|
|
38
|
+
```
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
| Property | Type |
|
|
4
4
|
| ------ | ------ |
|
|
5
|
-
| <a id="padding"></a> `padding?` | `"small"
|
|
6
|
-
| <a id="flexdirection"></a> `flexDirection?` | `"column"
|
|
7
|
-
| <a id="justifycontent"></a> `justifyContent?` | `"center"
|
|
8
|
-
| <a id="position"></a> `position?` | `"fixed"
|
|
5
|
+
| <a id="padding"></a> `padding?` | `"small" \| "none"` |
|
|
6
|
+
| <a id="flexdirection"></a> `flexDirection?` | `"column" \| "row" \| "rowReverse" \| "columnReverse"` |
|
|
7
|
+
| <a id="justifycontent"></a> `justifyContent?` | `"center" \| "flexStart"` |
|
|
8
|
+
| <a id="position"></a> `position?` | `"fixed" \| "absolute"` |
|
|
@@ -21,6 +21,8 @@
|
|
|
21
21
|
| <a id="iconaudiotransmission"></a> `IconAudioTransmission` | [`IconSource`](IconSource.mdx) |
|
|
22
22
|
| <a id="iconauthenticated"></a> `IconAuthenticated` | [`IconSource`](IconSource.mdx) |
|
|
23
23
|
| <a id="iconbackgroundblur"></a> `IconBackgroundBlur` | [`IconSource`](IconSource.mdx) |
|
|
24
|
+
| <a id="iconbackgroundblurlight"></a> `IconBackgroundBlurLight` | [`IconSource`](IconSource.mdx) |
|
|
25
|
+
| <a id="iconbackgroundblurstrong"></a> `IconBackgroundBlurStrong` | [`IconSource`](IconSource.mdx) |
|
|
24
26
|
| <a id="iconbackgroundreplace"></a> `IconBackgroundReplace` | [`IconSource`](IconSource.mdx) |
|
|
25
27
|
| <a id="iconbackspace"></a> `IconBackspace` | [`IconSource`](IconSource.mdx) |
|
|
26
28
|
| <a id="iconbacktotop"></a> `IconBackToTop` | [`IconSource`](IconSource.mdx) |
|
|
@@ -97,6 +99,7 @@
|
|
|
97
99
|
| <a id="iconmorevertical"></a> `IconMoreVertical` | [`IconSource`](IconSource.mdx) |
|
|
98
100
|
| <a id="iconmove"></a> `IconMove` | [`IconSource`](IconSource.mdx) |
|
|
99
101
|
| <a id="iconnotauthenticated"></a> `IconNotauthenticated` | [`IconSource`](IconSource.mdx) |
|
|
102
|
+
| <a id="iconnotauthenticated-1"></a> `IconNotAuthenticated` | [`IconSource`](IconSource.mdx) |
|
|
100
103
|
| <a id="iconopeninnew"></a> `IconOpenInNew` | [`IconSource`](IconSource.mdx) |
|
|
101
104
|
| <a id="iconparticipant"></a> `IconParticipant` | [`IconSource`](IconSource.mdx) |
|
|
102
105
|
| <a id="iconpasswordhide"></a> `IconPasswordHide` | [`IconSource`](IconSource.mdx) |
|
|
@@ -124,6 +127,7 @@
|
|
|
124
127
|
| <a id="iconshare"></a> `IconShare` | [`IconSource`](IconSource.mdx) |
|
|
125
128
|
| <a id="iconshield"></a> `IconShield` | [`IconSource`](IconSource.mdx) |
|
|
126
129
|
| <a id="iconshuffle"></a> `IconShuffle` | [`IconSource`](IconSource.mdx) |
|
|
130
|
+
| <a id="iconsort"></a> `IconSort` | [`IconSource`](IconSource.mdx) |
|
|
127
131
|
| <a id="iconspeakerdisabled"></a> `IconSpeakerDisabled` | [`IconSource`](IconSource.mdx) |
|
|
128
132
|
| <a id="iconspeakeroff"></a> `IconSpeakerOff` | [`IconSource`](IconSource.mdx) |
|
|
129
133
|
| <a id="iconspeakeron"></a> `IconSpeakerOn` | [`IconSource`](IconSource.mdx) |
|
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
| Property | Type |
|
|
4
4
|
| ------ | ------ |
|
|
5
|
-
| <a id="size16"></a> `size16` | `FC
|
|
6
|
-
| <a id="size24"></a> `size24` | `FC
|
|
7
|
-
| <a id="size32"></a> `size32` | `FC
|
|
5
|
+
| <a id="size16"></a> `size16` | `FC<SVGProps<SVGSVGElement>>` |
|
|
6
|
+
| <a id="size24"></a> `size24` | `FC<SVGProps<SVGSVGElement>>` |
|
|
7
|
+
| <a id="size32"></a> `size32` | `FC<SVGProps<SVGSVGElement>>` |
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
## Extends
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
```ts
|
|
4
|
+
- Pick<React.ComponentProps<typeof Spinner>, "sizeModifier" | "colorScheme">
|
|
5
|
+
```
|
|
4
6
|
|
|
5
7
|
## Properties
|
|
6
8
|
|
|
@@ -8,5 +10,5 @@
|
|
|
8
10
|
| ------ | ------ | ------ |
|
|
9
11
|
| <a id="classname"></a> `className?` | `string` | - |
|
|
10
12
|
| <a id="isloading"></a> `isLoading?` | `boolean` | - |
|
|
11
|
-
| <a id="sizemodifier"></a> `sizeModifier?` | `"small"
|
|
12
|
-
| <a id="colorscheme"></a> `colorScheme?` | `"dark"
|
|
13
|
+
| <a id="sizemodifier"></a> `sizeModifier?` | `"small" \| "medium" \| "compact"` | `Pick.sizeModifier` |
|
|
14
|
+
| <a id="colorscheme"></a> `colorScheme?` | `"dark" \| "light"` | `Pick.colorScheme` |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
| ------ | ------ |
|
|
5
5
|
| <a id="label"></a> `label` | `string` |
|
|
6
6
|
| <a id="url"></a> `url?` | `string` |
|
|
7
|
-
| <a id="onclick"></a> `onClick?` | () =>
|
|
7
|
+
| <a id="onclick"></a> `onClick?` | `() => void` |
|
|
8
8
|
| <a id="iscompleted"></a> `isCompleted?` | `boolean` |
|
|
9
9
|
| <a id="isfailed"></a> `isFailed?` | `boolean` |
|
|
10
10
|
| <a id="isdisabled"></a> `isDisabled?` | `boolean` |
|
|
@@ -2,14 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
| Property | Type |
|
|
4
4
|
| ------ | ------ |
|
|
5
|
-
| <a id="caption"></a> `caption?` |
|
|
5
|
+
| <a id="caption"></a> `caption?` | `\| string \| ReactElement<unknown, string` | JSXElementConstructor\<any\>\>` |
|
|
6
6
|
| <a id="captionclassname"></a> `captionClassName?` | `string` |
|
|
7
|
-
| <a id="captionsize"></a> `captionSize?` | `"small"
|
|
7
|
+
| <a id="captionsize"></a> `captionSize?` | `"small" \| "medium"` |
|
|
8
8
|
| <a id="captiontitle"></a> `captionTitle?` | `string` |
|
|
9
|
-
| <a id="figure"></a> `figure?` |
|
|
9
|
+
| <a id="figure"></a> `figure?` | `\| string \| number \| ReactElement<unknown, string` | JSXElementConstructor\<any\>\>` |
|
|
10
10
|
| <a id="figureclassname"></a> `figureClassName?` | `string` |
|
|
11
|
-
| <a id="figuresize"></a> `figureSize?` | `"small"
|
|
11
|
+
| <a id="figuresize"></a> `figureSize?` | `"small" \| "medium"` |
|
|
12
12
|
| <a id="figuretitle"></a> `figureTitle?` | `string` |
|
|
13
|
-
| <a id="icon"></a> `icon?` | `ReactElement
|
|
13
|
+
| <a id="icon"></a> `icon?` | `ReactElement<unknown, string \| JSXElementConstructor<any>>` |
|
|
14
14
|
| <a id="iconcolor"></a> `iconColor?` | `string` |
|
|
15
15
|
| <a id="isactive"></a> `isActive?` | `boolean` |
|
|
@@ -3,12 +3,12 @@
|
|
|
3
3
|
| Property | Type |
|
|
4
4
|
| ------ | ------ |
|
|
5
5
|
| <a id="classname"></a> `className?` | `string` |
|
|
6
|
-
| <a id="colorscheme"></a> `colorScheme?` | `"dark"
|
|
6
|
+
| <a id="colorscheme"></a> `colorScheme?` | `"dark" \| "light"` |
|
|
7
7
|
| <a id="enhancestart"></a> `enhanceStart?` | `ReactNode` |
|
|
8
8
|
| <a id="isclickable"></a> `isClickable?` | `boolean` |
|
|
9
9
|
| <a id="isdanger"></a> `isDanger?` | `boolean` |
|
|
10
10
|
| <a id="isdisplayed"></a> `isDisplayed` | `boolean` |
|
|
11
11
|
| <a id="message"></a> `message` | `ReactNode` |
|
|
12
|
-
| <a id="ondismiss"></a> `onDismiss?` | () =>
|
|
13
|
-
| <a id="position"></a> `position?` | `"bottomCenter"
|
|
12
|
+
| <a id="ondismiss"></a> `onDismiss?` | `() => void` |
|
|
13
|
+
| <a id="position"></a> `position?` | `"bottomCenter" \| "topCenter"` |
|
|
14
14
|
| <a id="timeout"></a> `timeout?` | `number` |
|
|
@@ -11,7 +11,7 @@ The structure of a menu item that can be used to create a dropdown menu.
|
|
|
11
11
|
| `key` | `string` | The unique key for the item. |
|
|
12
12
|
| `label` | `React.ReactNode` | The label of the item. |
|
|
13
13
|
| `testId?` | `string` | The test id for the item. |
|
|
14
|
-
| `onItemClick()?` | () =>
|
|
14
|
+
| `onItemClick()?` | `() => void` | If set, this function will be called when the user clicks this item. |
|
|
15
15
|
| `closeMenuOnItemClick?` | `boolean` | If set to false, the menu will not close when the user clicks this item. |
|
|
16
16
|
| `icon?` | `React.ReactNode` | The icon to display next to the item. |
|
|
17
17
|
| `alternativeHoverClassName?` | `string` | Class name that is used to override the default hover style. |
|
|
@@ -19,3 +19,6 @@ The structure of a menu item that can be used to create a dropdown menu.
|
|
|
19
19
|
| `className?` | `string` | The class name for the item. |
|
|
20
20
|
| `style?` | `CSSProperties` | The style for the item. |
|
|
21
21
|
| `isActive?` | `boolean` | Sets the `data-active` attribute to `true` and applies styling |
|
|
22
|
+
| `isDisabled?` | `boolean` | If set to true, the item will be disabled. |
|
|
23
|
+
| `withTopDivider?` | `boolean` | If set to true, a divider will be rendered above the item. |
|
|
24
|
+
| `withBottomDivider?` | `boolean` | If set to true, a divider will be rendered below the item. |
|
|
@@ -9,7 +9,7 @@ type AriaMenuProps = object;
|
|
|
9
9
|
| <a id="items"></a> `items` | [`AriaMenuItem`](AriaMenuItem.mdx)[] | An array of menu items. |
|
|
10
10
|
| <a id="button"></a> `button` | `ReactElement` | The react element that triggers the menu. |
|
|
11
11
|
| <a id="headercontent"></a> `headerContent?` | `ReactElement` | Optional content to show above the menu items. |
|
|
12
|
-
| <a id="onopenchange"></a> `onOpenChange?` | (
|
|
12
|
+
| <a id="onopenchange"></a> `onOpenChange?` | `(isOpen) => void` | Callback function called when the menu open state changes. |
|
|
13
13
|
| <a id="testid"></a> `testId?` | `string` | The test id for the menu. |
|
|
14
14
|
| <a id="colorscheme"></a> `colorScheme?` | [`ColorScheme`](ColorScheme.mdx) | The color scheme for the menu. |
|
|
15
15
|
| <a id="popoverplacement"></a> `popoverPlacement?` | `Placement` | The placement of the popover. |
|
|
@@ -9,7 +9,7 @@ type MenuAction = object;
|
|
|
9
9
|
| <a id="enhancerstart"></a> `enhancerStart?` | `React.ReactNode` |
|
|
10
10
|
| <a id="isdisabled"></a> `isDisabled?` | `boolean` |
|
|
11
11
|
| <a id="label"></a> `label` | `string` |
|
|
12
|
-
| <a id="onclick"></a> `onClick?` | () =>
|
|
12
|
+
| <a id="onclick"></a> `onClick?` | `() => void` |
|
|
13
13
|
| <a id="target"></a> `target?` | [`LinkTarget`](LinkTarget.mdx) |
|
|
14
14
|
| <a id="testid"></a> `testId?` | `string` |
|
|
15
15
|
| <a id="url"></a> `url?` | `string` |
|
|
@@ -6,13 +6,13 @@ type MenuItem<T> = object;
|
|
|
6
6
|
|
|
7
7
|
| Type Parameter | Default type |
|
|
8
8
|
| ------ | ------ |
|
|
9
|
-
| `T
|
|
9
|
+
| `T extends string` | `string` |
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
13
13
|
| Property | Type |
|
|
14
14
|
| ------ | ------ |
|
|
15
|
-
| <a id="clickaction"></a> `clickAction?` | `React.MouseEventHandler
|
|
15
|
+
| <a id="clickaction"></a> `clickAction?` | `React.MouseEventHandler<HTMLElement>` |
|
|
16
16
|
| <a id="colorscheme"></a> `colorScheme?` | [`ColorScheme`](ColorScheme.mdx) |
|
|
17
17
|
| <a id="icon"></a> `icon?` | [`IconSource`](../interfaces/IconSource.mdx) |
|
|
18
18
|
| <a id="iconcolor"></a> `iconColor?` | `string` |
|
|
@@ -22,7 +22,7 @@ type MenuItem<T> = object;
|
|
|
22
22
|
| <a id="isdisabled"></a> `isDisabled?` | `boolean` |
|
|
23
23
|
| <a id="isfixedicon"></a> `isFixedIcon?` | `boolean` |
|
|
24
24
|
| <a id="label"></a> `label` | `React.ReactNode` |
|
|
25
|
-
| <a id="linkwrapper"></a> `linkWrapper?` | (
|
|
25
|
+
| <a id="linkwrapper"></a> `linkWrapper?` | `({ children, }) => React.ReactElement` |
|
|
26
26
|
| <a id="role"></a> `role?` | `React.AriaRole` |
|
|
27
27
|
| <a id="target"></a> `target?` | [`LinkTarget`](LinkTarget.mdx) |
|
|
28
28
|
| <a id="testid"></a> `testId?` | `string` |
|
|
@@ -15,4 +15,4 @@ type NotificationToastMessage = object;
|
|
|
15
15
|
| <a id="position"></a> `position?` | [`ToastPosition`](ToastPosition.mdx) | - |
|
|
16
16
|
| <a id="testid"></a> `testid?` | `string` | - |
|
|
17
17
|
| <a id="timeout"></a> `timeout?` | `number` | - |
|
|
18
|
-
| <a id="ondismiss"></a> `onDismiss?` | () =>
|
|
18
|
+
| <a id="ondismiss"></a> `onDismiss?` | `() => void` | - |
|