@atlaskit/ads-mcp 0.17.1 → 0.17.3
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 +13 -0
- package/README.md +88 -0
- package/dist/cjs/index.js +19 -40
- package/dist/cjs/tools/get-all-icons/icons.js +43 -0
- package/dist/cjs/tools/get-all-icons/index.js +4 -19
- package/dist/cjs/tools/get-all-tokens/index.js +3 -6
- package/dist/cjs/tools/get-all-tokens/tokens.js +18 -0
- package/dist/cjs/tools/get-components/components.codegen.js +8 -0
- package/dist/cjs/tools/get-components/components.js +423 -235
- package/dist/cjs/tools/get-components/index.js +2 -2
- package/dist/cjs/tools/get-components/load-all-components.js +16 -0
- package/dist/cjs/tools/get-guidelines/guidelines-structured-content.codegen.js +72 -6
- package/dist/cjs/tools/get-lint-rules/lint-rules-structured-content.codegen.js +111 -7
- package/dist/cjs/tools/search-components/index.js +13 -12
- package/dist/cjs/tools/search-icons/index.js +7 -24
- package/dist/es2019/index.js +13 -31
- package/dist/es2019/tools/get-all-icons/icons.js +25 -0
- package/dist/es2019/tools/get-all-icons/index.js +1 -10
- package/dist/es2019/tools/get-all-tokens/index.js +2 -5
- package/dist/es2019/tools/get-all-tokens/tokens.js +13 -0
- package/dist/es2019/tools/get-components/components.codegen.js +8 -0
- package/dist/es2019/tools/get-components/components.js +423 -235
- package/dist/es2019/tools/get-components/index.js +11 -9
- package/dist/es2019/tools/get-components/load-all-components.js +10 -0
- package/dist/es2019/tools/get-guidelines/guidelines-structured-content.codegen.js +72 -6
- package/dist/es2019/tools/get-lint-rules/lint-rules-structured-content.codegen.js +111 -7
- package/dist/es2019/tools/search-components/index.js +2 -1
- package/dist/es2019/tools/search-icons/index.js +1 -10
- package/dist/esm/index.js +19 -40
- package/dist/esm/tools/get-all-icons/icons.js +37 -0
- package/dist/esm/tools/get-all-icons/index.js +3 -18
- package/dist/esm/tools/get-all-tokens/index.js +2 -5
- package/dist/esm/tools/get-all-tokens/tokens.js +13 -0
- package/dist/esm/tools/get-components/components.codegen.js +8 -0
- package/dist/esm/tools/get-components/components.js +423 -235
- package/dist/esm/tools/get-components/index.js +2 -2
- package/dist/esm/tools/get-components/load-all-components.js +10 -0
- package/dist/esm/tools/get-guidelines/guidelines-structured-content.codegen.js +72 -6
- package/dist/esm/tools/get-lint-rules/lint-rules-structured-content.codegen.js +111 -7
- package/dist/esm/tools/search-components/index.js +9 -8
- package/dist/esm/tools/search-icons/index.js +3 -20
- package/dist/types/tools/get-all-icons/icons.d.ts +11 -0
- package/dist/types/tools/get-all-tokens/tokens.d.ts +7 -0
- package/dist/types/tools/get-components/components.codegen.d.ts +10 -0
- package/dist/types/tools/get-components/components.d.ts +1 -1
- package/dist/types/tools/get-components/load-all-components.d.ts +2 -0
- package/dist/types/tools/get-components/types.d.ts +20 -14
- package/dist/types/tools/get-guidelines/guidelines-structured-content.codegen.d.ts +1 -1
- package/dist/types/tools/get-lint-rules/lint-rules-structured-content.codegen.d.ts +1 -1
- package/dist/types-ts4.5/tools/get-all-icons/icons.d.ts +11 -0
- package/dist/types-ts4.5/tools/get-all-tokens/tokens.d.ts +7 -0
- package/dist/types-ts4.5/tools/get-components/components.codegen.d.ts +10 -0
- package/dist/types-ts4.5/tools/get-components/components.d.ts +1 -1
- package/dist/types-ts4.5/tools/get-components/load-all-components.d.ts +2 -0
- package/dist/types-ts4.5/tools/get-components/types.d.ts +20 -14
- package/dist/types-ts4.5/tools/get-guidelines/guidelines-structured-content.codegen.d.ts +1 -1
- package/dist/types-ts4.5/tools/get-lint-rules/lint-rules-structured-content.codegen.d.ts +1 -1
- package/package.json +5 -3
- package/dist/cjs/tools/get-icons/icon-mcp-structured-content.codegen.js +0 -8
- package/dist/cjs/tools/get-icons/icon-structured-content.codegen.js +0 -8
- package/dist/cjs/tools/get-icons/index.js +0 -135
- package/dist/cjs/tools/get-tokens/index.js +0 -125
- package/dist/cjs/tools/get-tokens/token-mcp-structured-content.codegen.js +0 -2356
- package/dist/cjs/tools/get-tokens/token-structured-content.codegen.js +0 -2356
- package/dist/es2019/tools/get-icons/icon-mcp-structured-content.codegen.js +0 -8
- package/dist/es2019/tools/get-icons/icon-structured-content.codegen.js +0 -8
- package/dist/es2019/tools/get-icons/index.js +0 -110
- package/dist/es2019/tools/get-tokens/index.js +0 -100
- package/dist/es2019/tools/get-tokens/token-mcp-structured-content.codegen.js +0 -2350
- package/dist/es2019/tools/get-tokens/token-structured-content.codegen.js +0 -2350
- package/dist/esm/tools/get-icons/icon-mcp-structured-content.codegen.js +0 -8
- package/dist/esm/tools/get-icons/icon-structured-content.codegen.js +0 -8
- package/dist/esm/tools/get-icons/index.js +0 -128
- package/dist/esm/tools/get-tokens/index.js +0 -118
- package/dist/esm/tools/get-tokens/token-mcp-structured-content.codegen.js +0 -2350
- package/dist/esm/tools/get-tokens/token-structured-content.codegen.js +0 -2350
- package/dist/types/tools/get-icons/icon-mcp-structured-content.codegen.d.ts +0 -13
- package/dist/types/tools/get-icons/icon-structured-content.codegen.d.ts +0 -13
- package/dist/types/tools/get-icons/index.d.ts +0 -35
- package/dist/types/tools/get-tokens/index.d.ts +0 -35
- package/dist/types/tools/get-tokens/token-mcp-structured-content.codegen.d.ts +0 -13
- package/dist/types/tools/get-tokens/token-structured-content.codegen.d.ts +0 -13
- package/dist/types-ts4.5/tools/get-icons/icon-mcp-structured-content.codegen.d.ts +0 -13
- package/dist/types-ts4.5/tools/get-icons/icon-structured-content.codegen.d.ts +0 -13
- package/dist/types-ts4.5/tools/get-icons/index.d.ts +0 -35
- package/dist/types-ts4.5/tools/get-tokens/index.d.ts +0 -35
- package/dist/types-ts4.5/tools/get-tokens/token-mcp-structured-content.codegen.d.ts +0 -13
- package/dist/types-ts4.5/tools/get-tokens/token-structured-content.codegen.d.ts +0 -13
|
@@ -3,9 +3,10 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Generates TypeScript components data for AI tooling from offerings.json files
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
6
|
+
* @codegen <<SignedSource::8e120a2eb2205e4c89f4bdddbf4e436f>>
|
|
7
7
|
* @codegenCommand yarn workspace @af/ads-ai-tooling codegen:prototyping
|
|
8
8
|
*/
|
|
9
|
+
/* eslint-disable @repo/internal/react/boolean-prop-naming-convention -- not our types */
|
|
9
10
|
|
|
10
11
|
export var components = [{
|
|
11
12
|
name: 'Avatar',
|
|
@@ -21,6 +22,18 @@ export var components = [{
|
|
|
21
22
|
name: 'appearance',
|
|
22
23
|
description: "Indicates the shape of the avatar. Most avatars are circular, but square avatars\ncan be used for 'container' objects.",
|
|
23
24
|
type: '"circle" | "square" | "hexagon"'
|
|
25
|
+
}, {
|
|
26
|
+
name: 'aria-controls',
|
|
27
|
+
description: 'Identifies the popup element that the avatar controls.\nUsed when Avatar is a trigger for a popup.',
|
|
28
|
+
type: 'string'
|
|
29
|
+
}, {
|
|
30
|
+
name: 'aria-expanded',
|
|
31
|
+
description: 'Announces to assistive technology whether the controlled popup is currently open or closed.',
|
|
32
|
+
type: 'boolean'
|
|
33
|
+
}, {
|
|
34
|
+
name: 'aria-haspopup',
|
|
35
|
+
description: 'Informs assistive technology that this element triggers a popup.\nWhen set, Avatar will render as a `<button>` element even without `onClick`.',
|
|
36
|
+
type: 'boolean | "dialog"'
|
|
24
37
|
}, {
|
|
25
38
|
name: 'as',
|
|
26
39
|
description: 'Replace the wrapping element. This accepts the name of a html tag which will\nbe used to wrap the element.',
|
|
@@ -104,11 +117,13 @@ export var components = [{
|
|
|
104
117
|
props: [{
|
|
105
118
|
name: 'appearance',
|
|
106
119
|
description: 'Indicates the layout of the avatar group.\nAvatars will either be overlapped in a stack, or\nlaid out in an even grid formation.\nDefaults to "stack".',
|
|
107
|
-
type: '"grid" | "stack"'
|
|
120
|
+
type: '"grid" | "stack"',
|
|
121
|
+
defaultValue: '"stack"'
|
|
108
122
|
}, {
|
|
109
123
|
name: 'avatar',
|
|
110
124
|
description: 'Component used to render each avatar.',
|
|
111
|
-
type: 'React.ForwardRefExoticComponent<AvatarPropTypes & React.RefAttributes<HTMLElement>> | React.ElementType<AvatarProps>'
|
|
125
|
+
type: 'React.ForwardRefExoticComponent<AvatarPropTypes & React.RefAttributes<HTMLElement>> | React.ElementType<AvatarProps, keyof React.JSX.IntrinsicElements>',
|
|
126
|
+
defaultValue: 'Avatar'
|
|
112
127
|
}, {
|
|
113
128
|
name: 'borderColor',
|
|
114
129
|
description: 'Typically the background color that the avatar is presented on.\nAccepts any color argument that the CSS border-color property accepts.',
|
|
@@ -120,7 +135,8 @@ export var components = [{
|
|
|
120
135
|
}, {
|
|
121
136
|
name: 'data',
|
|
122
137
|
description: "An array of avatar prop data, that are spread onto each `avatar` component.\n\nFor further usage information on AvatarPropTypes, the supported props for `avatar`, refer to [Avatar's prop documentation](https://atlassian.design/components/avatar/code).",
|
|
123
|
-
type: '(AvatarPropTypes & { name: string; key?: string | number; })[]'
|
|
138
|
+
type: '(AvatarPropTypes & { name: string; key?: string | number; })[]',
|
|
139
|
+
isRequired: true
|
|
124
140
|
}, {
|
|
125
141
|
name: 'isTooltipDisabled',
|
|
126
142
|
description: 'Disables tooltips.',
|
|
@@ -128,7 +144,8 @@ export var components = [{
|
|
|
128
144
|
}, {
|
|
129
145
|
name: 'label',
|
|
130
146
|
description: 'Text to be used as aria-label for the list of avatars.\nScreen reader announcement with default label, which is `avatar group`, is `list, avatar group, X items`.\n\nThe label should describe the `AvatarGroup`\'s entities, for instance:\n- `label="team members"`, screen reader announcement would be `list team members, X items`\n- `label="reviewers"` screen reader announcement would be `list reviewers, X items`\n\nWhen there are several AvatarGroups on the page you should use a unique label to let users distinguish different lists.',
|
|
131
|
-
type: 'string'
|
|
147
|
+
type: 'string',
|
|
148
|
+
defaultValue: '"avatar group"'
|
|
132
149
|
}, {
|
|
133
150
|
name: 'maxCount',
|
|
134
151
|
description: 'The maximum number of avatars allowed in the list.\nDefaults to 5 when displayed as a stack,\nand 11 when displayed as a grid.',
|
|
@@ -152,19 +169,23 @@ export var components = [{
|
|
|
152
169
|
}, {
|
|
153
170
|
name: 'shouldPopupRenderToParent',
|
|
154
171
|
description: "Determines whether the 'show more' popup has `shouldRenderToParent` applied.",
|
|
155
|
-
type: 'boolean'
|
|
172
|
+
type: 'boolean',
|
|
173
|
+
defaultValue: 'false'
|
|
156
174
|
}, {
|
|
157
175
|
name: 'showMoreButtonProps',
|
|
158
176
|
description: 'Provide additional props to the MoreButton.\nExample use cases: altering tab order by providing tabIndex;\nadding onClick behaviour without losing the default dropdown',
|
|
159
|
-
type: '{ defaultChecked?: boolean; defaultValue?: string | number | readonly string[]; suppressContentEditableWarning?: boolean; suppressHydrationWarning?: boolean; accessKey?: string;
|
|
177
|
+
type: '{ defaultChecked?: boolean; defaultValue?: string | number | readonly string[]; suppressContentEditableWarning?: boolean; suppressHydrationWarning?: boolean; accessKey?: string; autoCapitalize?: (string & {}) | ... 5 more ... | "characters"; ... 257 more ...; onTransitionEndCapture?: React.TransitionEventHandler<......',
|
|
178
|
+
defaultValue: '{}'
|
|
160
179
|
}, {
|
|
161
180
|
name: 'size',
|
|
162
181
|
description: 'Defines the size of the avatar.\nDefaults to "medium".\n\nNote: The "xsmall" size that exists on Avatar is not supported here because elements such as the more indicator cannot be displayed in an accessible manner at that size.',
|
|
163
|
-
type: '"small" | "medium" | "large" | "xlarge" | "xxlarge"'
|
|
182
|
+
type: '"small" | "medium" | "large" | "xlarge" | "xxlarge"',
|
|
183
|
+
defaultValue: '"medium"'
|
|
164
184
|
}, {
|
|
165
185
|
name: 'tooltipPosition',
|
|
166
186
|
description: 'Where the tooltip should appear relative to its target.\nDefaults to tooltip position "bottom".',
|
|
167
|
-
type: '"top" | "bottom"'
|
|
187
|
+
type: '"top" | "bottom"',
|
|
188
|
+
defaultValue: '"bottom"'
|
|
168
189
|
}]
|
|
169
190
|
}, {
|
|
170
191
|
name: 'Badge',
|
|
@@ -197,7 +218,7 @@ export var components = [{
|
|
|
197
218
|
category: 'messaging',
|
|
198
219
|
description: 'A banner displays a prominent message at the top of the screen to communicate important information to users.',
|
|
199
220
|
status: 'general-availability',
|
|
200
|
-
examples: ['import Banner from \'@atlaskit/banner\';\nimport WarningIcon from \'@atlaskit/icon/core/status-warning\';\nimport Box from \'@atlaskit/primitives/box\';\nexport default (): React.JSX.Element => (\n\t<Box>\n\t\t<Banner
|
|
221
|
+
examples: ['import Banner from \'@atlaskit/banner\';\nimport WarningIcon from \'@atlaskit/icon/core/status-warning\';\nimport Box from \'@atlaskit/primitives/box\';\nexport default (): React.JSX.Element => (\n\t<Box>\n\t\t<Banner icon={<WarningIcon label="Warning" spacing="spacious" />} testId="basicTestId">\n\t\t\tYour license is about to expire. Please renew your license within the next week.\n\t\t</Banner>\n\t</Box>\n);'],
|
|
201
222
|
accessibilityGuidelines: ['Ensure banner content is announced by screen readers', 'Use appropriate color contrast for text readability', 'Provide clear, actionable messaging', 'Consider keyboard navigation for interactive banners'],
|
|
202
223
|
usageGuidelines: ['Use for important messages that need immediate attention', 'Place at the top of the screen for maximum visibility', 'Keep messaging concise and actionable', 'Use appropriate appearance variants for different message types', 'Consider dismissibility for non-critical messages'],
|
|
203
224
|
contentGuidelines: ['Write clear, concise messages', 'Use action-oriented language when appropriate', 'Ensure messages are relevant to the current context', 'Provide clear next steps when needed'],
|
|
@@ -312,7 +333,8 @@ export var components = [{
|
|
|
312
333
|
}, {
|
|
313
334
|
name: 'children',
|
|
314
335
|
description: 'Text content to be rendered in the button.',
|
|
315
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
336
|
+
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal',
|
|
337
|
+
isRequired: true
|
|
316
338
|
}, {
|
|
317
339
|
name: 'iconAfter',
|
|
318
340
|
description: "Places an icon within the button, after the button's text.",
|
|
@@ -361,7 +383,7 @@ export var components = [{
|
|
|
361
383
|
category: 'form',
|
|
362
384
|
description: 'A button that displays only an icon with an optional tooltip. Perfect for toolbar actions, compact interfaces, and when space is limited.',
|
|
363
385
|
status: 'general-availability',
|
|
364
|
-
examples: ['import { IconButton } from \'@atlaskit/button/new\';\nimport AddIcon from \'@atlaskit/icon/core/add\';\nimport DeleteIcon from \'@atlaskit/icon/core/delete\';\nimport InfoIcon from \'@atlaskit/icon/core/status-information\';\
|
|
386
|
+
examples: ['import { IconButton } from \'@atlaskit/button/new\';\nimport AddIcon from \'@atlaskit/icon/core/add\';\nimport DeleteIcon from \'@atlaskit/icon/core/delete\';\nimport InfoIcon from \'@atlaskit/icon/core/status-information\';\nconst _default_1: React.JSX.Element[] = [\n\t<IconButton icon={AddIcon} label="Add new item" appearance="primary" />,\n\t<IconButton icon={InfoIcon} label="Show information" appearance="subtle" spacing="compact" />,\n\t<IconButton icon={DeleteIcon} label="Delete permanently" appearance="discovery" shape="circle" />,\n];\nexport default _default_1;'],
|
|
365
387
|
usageGuidelines: ['Use for toolbar actions and compact interfaces', 'Choose icons that clearly represent their function', 'Group related icon buttons together', 'Use sparingly to avoid visual clutter', 'Consider using tooltips for additional context', 'Always provide a meaningful label for accessibility', 'The icon should clearly represent the action it performs'],
|
|
366
388
|
contentGuidelines: ['Use clear, concise, descriptive labels', 'Use action verbs (e.g., "Edit item", "Delete comment")', 'Choose icons that are universally understood', 'Avoid using icons without labels in critical actions'],
|
|
367
389
|
props: [{
|
|
@@ -375,7 +397,8 @@ export var components = [{
|
|
|
375
397
|
}, {
|
|
376
398
|
name: 'icon',
|
|
377
399
|
description: 'Places an icon within the button.',
|
|
378
|
-
type: 'ComponentClass<Omit<IconProps, "size"> | Omit<NewIconProps, "spacing" | "size">, any> | FunctionComponent<Omit<IconProps, "size"> | Omit<...>>'
|
|
400
|
+
type: 'ComponentClass<Omit<IconProps, "size"> | Omit<NewIconProps, "spacing" | "size">, any> | FunctionComponent<Omit<IconProps, "size"> | Omit<...>>',
|
|
401
|
+
isRequired: true
|
|
379
402
|
}, {
|
|
380
403
|
name: 'isDisabled',
|
|
381
404
|
description: 'Disable the button to prevent user interaction.',
|
|
@@ -395,7 +418,8 @@ export var components = [{
|
|
|
395
418
|
}, {
|
|
396
419
|
name: 'label',
|
|
397
420
|
description: 'Provide an accessible label, often used by screen readers.',
|
|
398
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
421
|
+
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal',
|
|
422
|
+
isRequired: true
|
|
399
423
|
}, {
|
|
400
424
|
name: 'onBlur',
|
|
401
425
|
description: 'Handler called on blur.',
|
|
@@ -419,7 +443,7 @@ export var components = [{
|
|
|
419
443
|
}, {
|
|
420
444
|
name: 'tooltip',
|
|
421
445
|
description: 'Props passed down to the Tooltip component.',
|
|
422
|
-
type: '{ testId?: string; analyticsContext?: Record<string, any>; content?: ReactNode | (({ update }: { update?: () => void; }) => ReactNode); component?: ComponentType<TooltipPrimitiveProps> | ForwardRefExoticComponent<...>; ...
|
|
446
|
+
type: '{ testId?: string; analyticsContext?: Record<string, any>; content?: ReactNode | (({ update }: { update?: () => void; }) => ReactNode); component?: ComponentType<TooltipPrimitiveProps> | ForwardRefExoticComponent<...>; ... 15 more ...; UNSAFE_shouldRenderToParent?: boolean; }'
|
|
423
447
|
}]
|
|
424
448
|
}, {
|
|
425
449
|
name: 'SplitButton',
|
|
@@ -428,26 +452,30 @@ export var components = [{
|
|
|
428
452
|
category: 'form',
|
|
429
453
|
description: 'A button that splits into a primary action and a dropdown menu. The main button performs the primary action, while the dropdown arrow reveals additional related actions.',
|
|
430
454
|
status: 'general-availability',
|
|
431
|
-
examples: ["import Button, { IconButton, SplitButton } from '@atlaskit/button/new';\nimport DropdownMenu, { DropdownItem, DropdownItemGroup } from '@atlaskit/dropdown-menu';\nimport ChevronDownIcon from '@atlaskit/icon/core/chevron-down';\
|
|
455
|
+
examples: ["import Button, { IconButton, SplitButton } from '@atlaskit/button/new';\nimport DropdownMenu, { DropdownItem, DropdownItemGroup } from '@atlaskit/dropdown-menu';\nimport ChevronDownIcon from '@atlaskit/icon/core/chevron-down';\nconst _default_1: React.JSX.Element = (\n\t<SplitButton spacing=\"compact\">\n\t\t<Button>Link work item</Button>\n\t\t<DropdownMenu\n\t\t\tshouldRenderToParent\n\t\t\ttrigger={({ triggerRef, ...triggerProps }) => (\n\t\t\t\t<IconButton\n\t\t\t\t\tref={triggerRef}\n\t\t\t\t\t{...triggerProps}\n\t\t\t\t\ticon={ChevronDownIcon}\n\t\t\t\t\tlabel=\"More link work item options\"\n\t\t\t\t/>\n\t\t\t)}\n\t\t>\n\t\t\t<DropdownItemGroup>\n\t\t\t\t<DropdownItem>Create new link</DropdownItem>\n\t\t\t\t<DropdownItem>Link existing item</DropdownItem>\n\t\t\t</DropdownItemGroup>\n\t\t</DropdownMenu>\n\t</SplitButton>\n);\nexport default _default_1;"],
|
|
432
456
|
accessibilityGuidelines: ['Provide descriptive labels for the IconButton trigger'],
|
|
433
457
|
usageGuidelines: ['Always must have exactly two children: `Button` and `DropdownMenu` that are related to each other', 'Use `shouldRenderToParent` on `DropdownMenu` for proper positioning', 'Make the primary action the most common or important action', 'Limit dropdown items to avoid overwhelming users'],
|
|
434
458
|
contentGuidelines: ['Use clear, action-oriented text for the primary button', 'Keep dropdown item labels concise and descriptive', 'Use consistent terminology across related actions'],
|
|
435
459
|
props: [{
|
|
436
460
|
name: 'appearance',
|
|
437
461
|
description: 'The style variation for child buttons. Will override any appearance set on a child button.',
|
|
438
|
-
type: '"default" | "primary"'
|
|
462
|
+
type: '"default" | "primary"',
|
|
463
|
+
defaultValue: '"default"'
|
|
439
464
|
}, {
|
|
440
465
|
name: 'children',
|
|
441
466
|
description: 'Only two children are allowed.\nFirst child is the primary action, second child is the secondary action.\nThe assumption is that for both children trees there is a button reading the context.',
|
|
442
|
-
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.ReactPortal'
|
|
467
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.ReactPortal',
|
|
468
|
+
isRequired: true
|
|
443
469
|
}, {
|
|
444
470
|
name: 'isDisabled',
|
|
445
471
|
description: 'Whether all child buttons should be disabled.',
|
|
446
|
-
type: 'boolean'
|
|
472
|
+
type: 'boolean',
|
|
473
|
+
defaultValue: 'false'
|
|
447
474
|
}, {
|
|
448
475
|
name: 'spacing',
|
|
449
476
|
description: 'Controls the amount of padding in the child buttons.',
|
|
450
|
-
type: '"default" | "compact"'
|
|
477
|
+
type: '"default" | "compact"',
|
|
478
|
+
defaultValue: '"default"'
|
|
451
479
|
}]
|
|
452
480
|
}, {
|
|
453
481
|
name: 'LinkButton',
|
|
@@ -456,7 +484,7 @@ export var components = [{
|
|
|
456
484
|
category: 'form',
|
|
457
485
|
description: 'A button that renders as an anchor tag for navigation. Combines the visual appearance of a button with the semantic behavior of a link.',
|
|
458
486
|
status: 'general-availability',
|
|
459
|
-
examples: ['import { LinkButton } from \'@atlaskit/button/new\';\
|
|
487
|
+
examples: ['import { LinkButton } from \'@atlaskit/button/new\';\nconst _default_1: React.JSX.Element[] = [\n\t<LinkButton href="https://atlassian.com" target="_blank" appearance="subtle">\n\t\tExternal Link\n\t</LinkButton>,\n\t// With a Router (requires `<AppProvider routerLinkComponent={Link} />` setup at the root)\n\t<LinkButton href={{ to: \'/about\', replace: true }}>About Page</LinkButton>,\n];\nexport default _default_1;'],
|
|
460
488
|
usageGuidelines: ['Use for navigation actions that change the URL', 'Use for external links and internal navigation', "Consider using regular buttons for actions that don't navigate", 'Provide clear visual indication of link behavior', 'Use consistent styling with other buttons when appropriate', 'Use for navigation actions that should look like buttons but behave like links', 'Perfect for external links, internal navigation, or any action that changes the URL'],
|
|
461
489
|
contentGuidelines: ['Use clear, descriptive text that indicates the destination', 'Be specific about where the link will take the user', 'Use action-oriented language when appropriate', "Avoid generic terms like 'Click here' or 'Learn more'"],
|
|
462
490
|
props: [{
|
|
@@ -470,11 +498,13 @@ export var components = [{
|
|
|
470
498
|
}, {
|
|
471
499
|
name: 'children',
|
|
472
500
|
description: 'Text content to be rendered in the button.',
|
|
473
|
-
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal'
|
|
501
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal',
|
|
502
|
+
isRequired: true
|
|
474
503
|
}, {
|
|
475
504
|
name: 'href',
|
|
476
505
|
description: 'Provides a URL for link buttons. When using an AppProvider with a configured router link component, a `RouterLinkConfig` object type can be provided for advanced usage. See the [Link Button routing example](/components/button/examples#routing) for more details.',
|
|
477
|
-
type: 'string | RouterLinkConfig'
|
|
506
|
+
type: 'string | RouterLinkConfig',
|
|
507
|
+
isRequired: true
|
|
478
508
|
}, {
|
|
479
509
|
name: 'iconAfter',
|
|
480
510
|
description: "Places an icon within the button, after the button's text.",
|
|
@@ -519,7 +549,7 @@ export var components = [{
|
|
|
519
549
|
category: 'form',
|
|
520
550
|
description: 'A component for grouping related buttons together with consistent spacing and alignment.',
|
|
521
551
|
status: 'general-availability',
|
|
522
|
-
examples: ['import { ButtonGroup } from \'@atlaskit/button\';\nimport Button from \'@atlaskit/button/new\';\
|
|
552
|
+
examples: ['import { ButtonGroup } from \'@atlaskit/button\';\nimport Button from \'@atlaskit/button/new\';\nconst _default_1: React.JSX.Element[] = [\n\t<ButtonGroup titleId="heading-options">\n\t\t<Button appearance="primary">Save</Button>\n\t\t<Button appearance="danger">Delete</Button>\n\t\t<Button appearance="subtle">Cancel</Button>\n\t</ButtonGroup>,\n];\nexport default _default_1;'],
|
|
523
553
|
usageGuidelines: ['Use for related actions that belong together', 'Group buttons that perform similar or complementary actions', 'Maintain consistent spacing and alignment', 'Consider the visual hierarchy within the group', "Don't group unrelated actions together", 'Use when you have multiple related actions that should be visually grouped', 'Provides consistent spacing and alignment between buttons'],
|
|
524
554
|
contentGuidelines: ['Ensure button labels are consistent in tone and style', 'Use parallel structure for related actions', 'Keep labels concise but descriptive', 'Consider the order of actions within the group'],
|
|
525
555
|
props: [{
|
|
@@ -549,7 +579,7 @@ export var components = [{
|
|
|
549
579
|
props: [{
|
|
550
580
|
name: 'appearance',
|
|
551
581
|
description: 'The base styling to apply to the button.',
|
|
552
|
-
type: '"
|
|
582
|
+
type: '"default" | "danger" | "link" | "primary" | "subtle" | "subtle-link" | "warning"'
|
|
553
583
|
}, {
|
|
554
584
|
name: 'autoFocus',
|
|
555
585
|
description: 'Set the button to autofocus on mount.',
|
|
@@ -561,7 +591,7 @@ export var components = [{
|
|
|
561
591
|
}, {
|
|
562
592
|
name: 'component',
|
|
563
593
|
description: '',
|
|
564
|
-
type: 'ComponentType<AllHTMLAttributes<HTMLElement>> | ElementType<any>'
|
|
594
|
+
type: 'ComponentType<AllHTMLAttributes<HTMLElement>> | ElementType<any, keyof JSX.IntrinsicElements>'
|
|
565
595
|
}, {
|
|
566
596
|
name: 'href',
|
|
567
597
|
description: "Provides a URL that's used when the button is a link styled as a button.",
|
|
@@ -794,7 +824,7 @@ export var components = [{
|
|
|
794
824
|
category: 'data-display',
|
|
795
825
|
description: 'A component for displaying code snippets.',
|
|
796
826
|
status: 'general-availability',
|
|
797
|
-
examples: ["import { Code } from '@atlaskit/code';\
|
|
827
|
+
examples: ["import { Code } from '@atlaskit/code';\nconst _default_1: React.JSX.Element[] = [<Code>{`<Code />`}</Code>];\nexport default _default_1;"],
|
|
798
828
|
accessibilityGuidelines: ['Ensure code content is announced properly by screen readers', 'Use appropriate contrast for code readability', 'Consider code context and meaning'],
|
|
799
829
|
usageGuidelines: ['Use for inline code snippets', 'Consider syntax highlighting needs', 'Use appropriate font styling', 'Consider code block vs inline code'],
|
|
800
830
|
contentGuidelines: ['Use clear, readable code examples', 'Consider code formatting and indentation', 'Use meaningful variable names in examples', 'Keep code snippets concise'],
|
|
@@ -822,22 +852,25 @@ export var components = [{
|
|
|
822
852
|
category: 'data-display',
|
|
823
853
|
description: 'A component for displaying multi-line code blocks with syntax highlighting.',
|
|
824
854
|
status: 'general-availability',
|
|
825
|
-
examples: ['import { CodeBlock } from \'@atlaskit/code\';\nconst exampleCodeBlock = `export default ({ name }: { name: string }) => <div>Hello {name}</div>;`;\
|
|
855
|
+
examples: ['import { CodeBlock } from \'@atlaskit/code\';\nconst exampleCodeBlock = `export default ({ name }: { name: string }) => <div>Hello {name}</div>;`;\nconst _default_1: React.JSX.Element[] = [\n\t<CodeBlock highlight="15" language="tsx" text={exampleCodeBlock} />,\n];\nexport default _default_1;'],
|
|
826
856
|
accessibilityGuidelines: ['Ensure code blocks are announced properly by screen readers', 'Use appropriate contrast for code readability', 'Consider code context and meaning', 'Provide proper language identification'],
|
|
827
857
|
usageGuidelines: ['Use for multi-line code examples', 'Specify appropriate language for syntax highlighting', 'Consider code block sizing and scrolling', 'Use for code snippets that need formatting'],
|
|
828
858
|
contentGuidelines: ['Use clear, readable code examples', 'Consider code formatting and indentation', 'Use meaningful variable names in examples', 'Keep code blocks focused and relevant'],
|
|
829
859
|
props: [{
|
|
830
860
|
name: 'codeBidiWarningLabel',
|
|
831
861
|
description: 'Label for the bidi warning tooltip.',
|
|
832
|
-
type: 'string'
|
|
862
|
+
type: 'string',
|
|
863
|
+
defaultValue: "'Bidirectional characters change the order that text is rendered. This could be used to obscure malicious code.'"
|
|
833
864
|
}, {
|
|
834
865
|
name: 'firstLineNumber',
|
|
835
866
|
description: 'Sets the number of the first line, if showLineNumbers is set to true.',
|
|
836
|
-
type: 'number'
|
|
867
|
+
type: 'number',
|
|
868
|
+
defaultValue: '1'
|
|
837
869
|
}, {
|
|
838
870
|
name: 'hasBidiWarnings',
|
|
839
871
|
description: 'When set to `false`, disables code decorating with bidi warnings.',
|
|
840
|
-
type: 'boolean'
|
|
872
|
+
type: 'boolean',
|
|
873
|
+
defaultValue: 'true'
|
|
841
874
|
}, {
|
|
842
875
|
name: 'highlight',
|
|
843
876
|
description: 'Comma delimited lines to highlight.\n\nExample uses:\n- To highlight one line `highlight="3"`\n- To highlight a group of lines `highlight="1-5"`\n- To highlight multiple groups `highlight="1-5,7,10,15-20"`',
|
|
@@ -853,7 +886,8 @@ export var components = [{
|
|
|
853
886
|
}, {
|
|
854
887
|
name: 'isBidiWarningTooltipEnabled',
|
|
855
888
|
description: 'Sets whether to render tooltip with the warning or not.\nIntended to be disabled when used in a mobile view, such as in the editor via mobile bridge,\nwhere the tooltip could end up being cut off or otherwise not work as expected.',
|
|
856
|
-
type: 'boolean'
|
|
889
|
+
type: 'boolean',
|
|
890
|
+
defaultValue: 'true'
|
|
857
891
|
}, {
|
|
858
892
|
name: 'label',
|
|
859
893
|
description: "Text used to describe that the content of the code block is scrollable.\nSet only if the code block is scrollable. Defaults to 'Scrollable content'.",
|
|
@@ -861,19 +895,23 @@ export var components = [{
|
|
|
861
895
|
}, {
|
|
862
896
|
name: 'language',
|
|
863
897
|
description: 'Language reference designed to be populated from `SUPPORTED_LANGUAGES` in\n`design-system/code`. Run against language grammars from PrismJS (full list\navailable at [PrismJS documentation](https://prismjs.com/#supported-languages)).\n\nWhen set to "text" will not perform highlighting. If unsupported language\nprovided - code will be treated as "text" with no highlighting.',
|
|
864
|
-
type: '"
|
|
898
|
+
type: '"PHP" | "php" | "php3" | "php4" | "php5" | "Java" | "java" | "CSharp" | "csharp" | "c#" | "Python" | "python" | "py" | "JavaScript" | "javascript" | "js" | "Html" | "html" | "xml" | ... 234 more ... | "markdown"',
|
|
899
|
+
defaultValue: "'text'"
|
|
865
900
|
}, {
|
|
866
901
|
name: 'shouldShowLineNumbers',
|
|
867
902
|
description: 'Sets whether to display code line numbers or not.',
|
|
868
|
-
type: 'boolean'
|
|
903
|
+
type: 'boolean',
|
|
904
|
+
defaultValue: 'true'
|
|
869
905
|
}, {
|
|
870
906
|
name: 'shouldWrapLongLines',
|
|
871
907
|
description: 'Sets whether long lines will create a horizontally scrolling container.\nWhen set to `true`, these lines will visually wrap instead.',
|
|
872
|
-
type: 'boolean'
|
|
908
|
+
type: 'boolean',
|
|
909
|
+
defaultValue: 'false'
|
|
873
910
|
}, {
|
|
874
911
|
name: 'text',
|
|
875
912
|
description: 'The code to be formatted.',
|
|
876
|
-
type: 'string'
|
|
913
|
+
type: 'string',
|
|
914
|
+
isRequired: true
|
|
877
915
|
}]
|
|
878
916
|
}, {
|
|
879
917
|
name: 'Comment',
|
|
@@ -889,47 +927,53 @@ export var components = [{
|
|
|
889
927
|
props: [{
|
|
890
928
|
name: 'actions',
|
|
891
929
|
description: 'A list of `CommentAction` items rendered as a row of buttons below the content.',
|
|
892
|
-
type: 'ReactNode[]'
|
|
930
|
+
type: 'React.ReactNode[]',
|
|
931
|
+
defaultValue: '[]'
|
|
893
932
|
}, {
|
|
894
933
|
name: 'afterContent',
|
|
895
934
|
description: "Content that is rendered after the comment's content.",
|
|
896
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
935
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal'
|
|
897
936
|
}, {
|
|
898
937
|
name: 'author',
|
|
899
938
|
description: 'A `CommentAuthor` element containing the name of the author.',
|
|
900
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
939
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal'
|
|
901
940
|
}, {
|
|
902
941
|
name: 'avatar',
|
|
903
942
|
description: "The element to display as the avatar. It's best to use `@atlaskit/avatar`.",
|
|
904
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
943
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal',
|
|
944
|
+
isRequired: true
|
|
905
945
|
}, {
|
|
906
946
|
name: 'children',
|
|
907
947
|
description: 'Provide nested comments as children.',
|
|
908
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
948
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal'
|
|
909
949
|
}, {
|
|
910
950
|
name: 'content',
|
|
911
951
|
description: 'The main content for the comment.',
|
|
912
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
952
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal'
|
|
913
953
|
}, {
|
|
914
954
|
name: 'edited',
|
|
915
955
|
description: 'A `CommentEdited` element which displays next to the time. Indicates whether the comment has been edited.',
|
|
916
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
956
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal'
|
|
917
957
|
}, {
|
|
918
958
|
name: 'errorActions',
|
|
919
959
|
description: 'A list of `CommentAction` items rendered with a warning icon instead of the actions.',
|
|
920
|
-
type: 'ReactNode[]'
|
|
960
|
+
type: 'React.ReactNode[]',
|
|
961
|
+
defaultValue: '[]'
|
|
921
962
|
}, {
|
|
922
963
|
name: 'errorIconLabel',
|
|
923
964
|
description: 'Text to show in the error icon label.',
|
|
924
|
-
type: 'string'
|
|
965
|
+
type: 'string',
|
|
966
|
+
defaultValue: '""'
|
|
925
967
|
}, {
|
|
926
968
|
name: 'headingLevel',
|
|
927
969
|
description: 'Use this to set the semantic heading level of the comment. The default comment heading has an `h3` tag. Make sure that headings are in the correct order and don’t skip levels.',
|
|
928
|
-
type: '"
|
|
970
|
+
type: '"3" | "1" | "2" | "4" | "5" | "6"',
|
|
971
|
+
defaultValue: '"3"'
|
|
929
972
|
}, {
|
|
930
973
|
name: 'highlighted',
|
|
931
974
|
description: 'Sets whether this comment should be highlighted.',
|
|
932
|
-
type: 'boolean'
|
|
975
|
+
type: 'boolean',
|
|
976
|
+
defaultValue: 'false'
|
|
933
977
|
}, {
|
|
934
978
|
name: 'id',
|
|
935
979
|
description: 'An ID to be applied to the comment.',
|
|
@@ -937,19 +981,23 @@ export var components = [{
|
|
|
937
981
|
}, {
|
|
938
982
|
name: 'isError',
|
|
939
983
|
description: 'Indicates whether the component is in an error state. Hides actions and time.',
|
|
940
|
-
type: 'boolean'
|
|
984
|
+
type: 'boolean',
|
|
985
|
+
defaultValue: 'false'
|
|
941
986
|
}, {
|
|
942
987
|
name: 'isSaving',
|
|
943
988
|
description: 'Enables "optimistic saving" mode which removes actions and displays text from the `savingText` prop.',
|
|
944
|
-
type: 'boolean'
|
|
989
|
+
type: 'boolean',
|
|
990
|
+
defaultValue: 'false'
|
|
945
991
|
}, {
|
|
946
992
|
name: 'restrictedTo',
|
|
947
993
|
description: 'Text for the "restricted to" label. This will display in the top items, before the main content.',
|
|
948
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
994
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal',
|
|
995
|
+
defaultValue: '""'
|
|
949
996
|
}, {
|
|
950
997
|
name: 'savingText',
|
|
951
998
|
description: 'Text to show when in "optimistic saving" mode.',
|
|
952
|
-
type: 'string'
|
|
999
|
+
type: 'string',
|
|
1000
|
+
defaultValue: '"Sending..."'
|
|
953
1001
|
}, {
|
|
954
1002
|
name: 'shouldHeaderWrap',
|
|
955
1003
|
description: 'Controls if the comment header should wrap.',
|
|
@@ -961,7 +1009,7 @@ export var components = [{
|
|
|
961
1009
|
}, {
|
|
962
1010
|
name: 'time',
|
|
963
1011
|
description: 'A `CommentTime` element containing the time to display.',
|
|
964
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
1012
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal'
|
|
965
1013
|
}, {
|
|
966
1014
|
name: 'type',
|
|
967
1015
|
description: 'The type of comment. This will be rendered in a lozenge at the top of the comment, before the main content.',
|
|
@@ -974,7 +1022,7 @@ export var components = [{
|
|
|
974
1022
|
category: 'form',
|
|
975
1023
|
description: 'A component for selecting date values with calendar support.',
|
|
976
1024
|
status: 'general-availability',
|
|
977
|
-
examples: ['import { DatePicker } from \'@atlaskit/datetime-picker\';\nconst Example = (): React.JSX.Element => (\n\t<DatePicker\n\t\tclearControlLabel="Clear select date"\n\t\tonChange={
|
|
1025
|
+
examples: ['import { DatePicker } from \'@atlaskit/datetime-picker\';\nimport __noop from \'@atlaskit/ds-lib/noop\';\nconst Example = (): React.JSX.Element => (\n\t<DatePicker\n\t\tclearControlLabel="Clear select date"\n\t\tonChange={__noop}\n\t\tshouldShowCalendarButton\n\t\topenCalendarLabel="open calendar"\n\t/>\n);\nexport default Example;'],
|
|
978
1026
|
accessibilityGuidelines: ['Ensure proper keyboard navigation', 'Use appropriate date formats', 'Provide clear date labels', 'Consider screen reader announcements'],
|
|
979
1027
|
usageGuidelines: ['Use for date selection only', 'Provide clear date formats', 'Handle date validation appropriately', 'Consider calendar button visibility'],
|
|
980
1028
|
contentGuidelines: ['Use clear, descriptive labels', 'Provide helpful placeholder text', 'Use appropriate date formats', 'Keep labels concise but descriptive'],
|
|
@@ -1017,7 +1065,8 @@ export var components = [{
|
|
|
1017
1065
|
}, {
|
|
1018
1066
|
name: 'inputLabel',
|
|
1019
1067
|
description: 'The name of the input, used when `shouldShowCalendarButton` is true. See `shouldShowCalendarButton` description for more details.',
|
|
1020
|
-
type: 'string'
|
|
1068
|
+
type: 'string',
|
|
1069
|
+
defaultValue: "'Date picker'"
|
|
1021
1070
|
}, {
|
|
1022
1071
|
name: 'inputLabelId',
|
|
1023
1072
|
description: 'The ID of the label for the input, used when `shouldShowCalendarButton` is\ntrue. See `shouldShowCalendarButton` description for more details.',
|
|
@@ -1081,7 +1130,8 @@ export var components = [{
|
|
|
1081
1130
|
}, {
|
|
1082
1131
|
name: 'openCalendarLabel',
|
|
1083
1132
|
description: 'The label associated with the button to open the calendar, rendered via the\n`shouldShowCalendarButton` prop. If a `label` prop is provided, this\ncalendar button label will be prefixed by the value of `label`. If no\n`label` prop is provided, this prefix should be manually added. For\nexample,\n\n```tsx\n<label id="label" htmlFor="datepicker">Desired Appointment Date</label>\n<DatePicker\n\tid="datepicker"\n\tshouldShowCalendarButton\n\tinputLabel="Desired Appointment Date"\n\topenCalendarLabel="open calendar"\n/>\n```',
|
|
1084
|
-
type: 'string'
|
|
1133
|
+
type: 'string',
|
|
1134
|
+
defaultValue: "'open calendar'"
|
|
1085
1135
|
}, {
|
|
1086
1136
|
name: 'parseInputValue',
|
|
1087
1137
|
description: 'A function for parsing input characters and transforming them into a Date object.\nBy default parses the date string based off the locale. Note that this does\nnot affect how the resulting value is displayed in the input. Use the\n`dateFormat` or `formatDisplayLabel` prop to handle how the value is\ndisplayed.',
|
|
@@ -1097,11 +1147,12 @@ export var components = [{
|
|
|
1097
1147
|
}, {
|
|
1098
1148
|
name: 'selectProps',
|
|
1099
1149
|
description: '',
|
|
1100
|
-
type: 'Omit<SelectProps<OptionType, false>, "aria-
|
|
1150
|
+
type: 'Omit<SelectProps<OptionType, false>, "aria-label" | "aria-describedby" | "inputId" | "placeholder"> & { \'aria-describedby\'?: never; \'aria-label\'?: never; inputId?: never; placeholder?: never; } & { ...; }'
|
|
1101
1151
|
}, {
|
|
1102
1152
|
name: 'shouldShowCalendarButton',
|
|
1103
1153
|
description: 'Provides a functional calendar button that opens the calendar picker that\nlives on the right side of the date picker.\n\nThe accessible name for this button is caculated using either the `label`,\n`inputLabel`, or `inputLabelId` props, along with the `openCalendarLabel`\nprop.',
|
|
1104
|
-
type: 'boolean'
|
|
1154
|
+
type: 'boolean',
|
|
1155
|
+
defaultValue: 'false'
|
|
1105
1156
|
}, {
|
|
1106
1157
|
name: 'spacing',
|
|
1107
1158
|
description: 'The spacing for the select control.\n\nCompact is `gridSize() * 4`, default is `gridSize * 5`.',
|
|
@@ -1122,7 +1173,7 @@ export var components = [{
|
|
|
1122
1173
|
category: 'form',
|
|
1123
1174
|
description: 'A component for selecting time values with clock interface.',
|
|
1124
1175
|
status: 'general-availability',
|
|
1125
|
-
examples: ['import { TimePicker } from \'@atlaskit/datetime-picker\';\nconst Example = (): React.JSX.Element => (\n\t<TimePicker\n\t\tclearControlLabel="Clear select time (editable)"\n\t\tdefaultValue="14:30"\n\t\tonChange={
|
|
1176
|
+
examples: ['import { TimePicker } from \'@atlaskit/datetime-picker\';\nimport __noop from \'@atlaskit/ds-lib/noop\';\nconst Example = (): React.JSX.Element => (\n\t<TimePicker\n\t\tclearControlLabel="Clear select time (editable)"\n\t\tdefaultValue="14:30"\n\t\tonChange={__noop}\n\t\ttimeFormat="HH:mm:ss A"\n\t\ttimeIsEditable\n\t\tselectProps={{\n\t\t\tclassNamePrefix: \'timepicker-select\',\n\t\t}}\n\t/>\n);\nexport default Example;'],
|
|
1126
1177
|
accessibilityGuidelines: ['Ensure proper keyboard navigation', 'Use appropriate time formats', 'Provide clear time labels', 'Consider screen reader announcements'],
|
|
1127
1178
|
usageGuidelines: ['Use for time selection only', 'Provide clear time formats', 'Handle time validation appropriately', 'Consider editable time input'],
|
|
1128
1179
|
contentGuidelines: ['Use clear, descriptive labels', 'Provide helpful placeholder text', 'Use appropriate time formats', 'Keep labels concise but descriptive'],
|
|
@@ -1234,81 +1285,81 @@ export var components = [{
|
|
|
1234
1285
|
category: 'form',
|
|
1235
1286
|
description: 'A component for selecting both date and time values.',
|
|
1236
1287
|
status: 'general-availability',
|
|
1237
|
-
examples: ["import { DateTimePicker } from '@atlaskit/datetime-picker';\nconst Example = (): React.JSX.Element => (\n\t<DateTimePicker\n\t\tclearControlLabel=\"Clear date / time picker (editable times)\"\n\t\tdefaultValue=\"2018-01-02T14:30+10:00\"\n\t\tonChange={
|
|
1288
|
+
examples: ["import { DateTimePicker } from '@atlaskit/datetime-picker';\nimport __noop from '@atlaskit/ds-lib/noop';\nconst Example = (): React.JSX.Element => (\n\t<DateTimePicker\n\t\tclearControlLabel=\"Clear date / time picker (editable times)\"\n\t\tdefaultValue=\"2018-01-02T14:30+10:00\"\n\t\tonChange={__noop}\n\t\ttimePickerProps={{\n\t\t\ttimeIsEditable: true,\n\t\t\tlabel: 'Time picker (editable)',\n\t\t}}\n\t\tdatePickerProps={{\n\t\t\tlabel: 'Date picker (editable times)',\n\t\t\tshouldShowCalendarButton: true,\n\t\t\topenCalendarLabel: 'open calendar',\n\t\t}}\n\t/>\n);\nexport default Example;"],
|
|
1238
1289
|
accessibilityGuidelines: ['Ensure proper keyboard navigation', 'Use appropriate date/time formats', 'Provide clear date/time labels', 'Consider screen reader announcements'],
|
|
1239
1290
|
usageGuidelines: ['Use for combined date and time selection', 'Provide clear date/time formats', 'Handle timezone considerations', 'Consider validation requirements'],
|
|
1240
1291
|
contentGuidelines: ['Use clear, descriptive labels', 'Provide helpful placeholder text', 'Use appropriate date/time formats', 'Keep labels concise but descriptive'],
|
|
1241
1292
|
props: [{
|
|
1242
1293
|
name: 'aria-describedby',
|
|
1243
|
-
description: 'Used to associate accessible descriptions to both the date and time\npicker. If you want to associate individual accessible descriptions, this\nshould be done through the `aria-describedby` props on the\n`datePickerProps` and `timePickerProps
|
|
1294
|
+
description: 'Used to associate accessible descriptions to both the date and time\npicker. If you want to associate individual accessible descriptions, this\nshould be done through the `aria-describedby` props on the\n`datePickerProps` and `timePickerProps`.',
|
|
1244
1295
|
type: 'string'
|
|
1245
1296
|
}, {
|
|
1246
1297
|
name: 'autoFocus',
|
|
1247
|
-
description: 'Set the picker to autofocus on mount
|
|
1298
|
+
description: 'Set the picker to autofocus on mount.',
|
|
1248
1299
|
type: 'boolean'
|
|
1249
1300
|
}, {
|
|
1250
1301
|
name: 'clearControlLabel',
|
|
1251
|
-
description: 'Set the `aria-label` for the clear button.\nAdd the word "Clear" at the beginning of the clearControlLabel.\nFor instance, for a field to set an appointment, use "Clear appointment date and time"
|
|
1302
|
+
description: 'Set the `aria-label` for the clear button.\nAdd the word "Clear" at the beginning of the clearControlLabel.\nFor instance, for a field to set an appointment, use "Clear appointment date and time".',
|
|
1252
1303
|
type: 'string'
|
|
1253
1304
|
}, {
|
|
1254
1305
|
name: 'datePickerProps',
|
|
1255
|
-
description: 'Props applied to the `DatePicker
|
|
1306
|
+
description: 'Props applied to the `DatePicker`.',
|
|
1256
1307
|
type: 'DatePickerBaseProps'
|
|
1257
1308
|
}, {
|
|
1258
1309
|
name: 'defaultValue',
|
|
1259
|
-
description: 'The default for `value
|
|
1310
|
+
description: 'The default for `value`.',
|
|
1260
1311
|
type: 'string'
|
|
1261
1312
|
}, {
|
|
1262
1313
|
name: 'id',
|
|
1263
|
-
description: 'Set the id of the field
|
|
1314
|
+
description: 'Set the id of the field.',
|
|
1264
1315
|
type: 'string'
|
|
1265
1316
|
}, {
|
|
1266
1317
|
name: 'isDisabled',
|
|
1267
|
-
description: 'Set if the field is disabled
|
|
1318
|
+
description: 'Set if the field is disabled.',
|
|
1268
1319
|
type: 'boolean'
|
|
1269
1320
|
}, {
|
|
1270
1321
|
name: 'isInvalid',
|
|
1271
|
-
description: 'Set if the picker has an invalid value
|
|
1322
|
+
description: 'Set if the picker has an invalid value.',
|
|
1272
1323
|
type: 'boolean'
|
|
1273
1324
|
}, {
|
|
1274
1325
|
name: 'isRequired',
|
|
1275
|
-
description: 'Set the field as required
|
|
1326
|
+
description: 'Set the field as required.',
|
|
1276
1327
|
type: 'boolean'
|
|
1277
1328
|
}, {
|
|
1278
1329
|
name: 'locale',
|
|
1279
|
-
description: 'Locale used for formatting dates and times. See [DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DateTimeFormat)
|
|
1330
|
+
description: 'Locale used for formatting dates and times. See [DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DateTimeFormat).',
|
|
1280
1331
|
type: 'string'
|
|
1281
1332
|
}, {
|
|
1282
1333
|
name: 'name',
|
|
1283
|
-
description: 'The name of the field
|
|
1334
|
+
description: 'The name of the field.',
|
|
1284
1335
|
type: 'string'
|
|
1285
1336
|
}, {
|
|
1286
1337
|
name: 'onBlur',
|
|
1287
|
-
description: 'Called when the field is blurred
|
|
1338
|
+
description: 'Called when the field is blurred.',
|
|
1288
1339
|
type: '(event: FocusEvent<HTMLInputElement, Element>) => void'
|
|
1289
1340
|
}, {
|
|
1290
1341
|
name: 'onChange',
|
|
1291
|
-
description: 'Called when the value changes and the date / time is a complete value, or empty. The only value is an ISO string or empty string
|
|
1292
|
-
type: '(value: string) => void'
|
|
1342
|
+
description: 'Called when the value changes and the date / time is a complete value, or empty. The only value is an ISO string or empty string.',
|
|
1343
|
+
type: '((value: string) => void) & ((value: string) => void)'
|
|
1293
1344
|
}, {
|
|
1294
1345
|
name: 'onFocus',
|
|
1295
|
-
description: 'Called when the field is focused
|
|
1346
|
+
description: 'Called when the field is focused.',
|
|
1296
1347
|
type: '(event: FocusEvent<HTMLInputElement, Element>) => void'
|
|
1297
1348
|
}, {
|
|
1298
1349
|
name: 'parseValue',
|
|
1299
|
-
description: 'Function used to parse datetime values into their date, time and timezone sub-values.
|
|
1300
|
-
type: '(dateTimeValue: string, date: string, time: string, timezone: string) => { dateValue: string; timeValue: string; zoneValue: string; }'
|
|
1350
|
+
description: 'Function used to parse datetime values into their date, time and timezone sub-values. *',
|
|
1351
|
+
type: '((dateTimeValue: string, date: string, time: string, timezone: string) => { dateValue: string; timeValue: string; zoneValue: string; }) & ((dateTimeValue: string, date: string, time: string, timezone: string) => { ...; })'
|
|
1301
1352
|
}, {
|
|
1302
1353
|
name: 'spacing',
|
|
1303
|
-
description: 'The spacing for the select control.\n\nCompact is `gridSize() * 4`, default is `gridSize() * 5
|
|
1354
|
+
description: 'The spacing for the select control.\n\nCompact is `gridSize() * 4`, default is `gridSize() * 5`.',
|
|
1304
1355
|
type: '"default" | "compact"'
|
|
1305
1356
|
}, {
|
|
1306
1357
|
name: 'timePickerProps',
|
|
1307
|
-
description: 'Props applied to the `TimePicker
|
|
1358
|
+
description: 'Props applied to the `TimePicker`.',
|
|
1308
1359
|
type: 'TimePickerBaseProps'
|
|
1309
1360
|
}, {
|
|
1310
1361
|
name: 'value',
|
|
1311
|
-
description: 'The ISO time that should be used as the input value
|
|
1362
|
+
description: 'The ISO time that should be used as the input value.',
|
|
1312
1363
|
type: 'string'
|
|
1313
1364
|
}]
|
|
1314
1365
|
}, {
|
|
@@ -1325,7 +1376,8 @@ export var components = [{
|
|
|
1325
1376
|
props: [{
|
|
1326
1377
|
name: 'autoFocusFirstElem',
|
|
1327
1378
|
description: 'Controls whether to focus the first tabbable element inside the focus lock. Set to `true` by default.',
|
|
1328
|
-
type: 'boolean'
|
|
1379
|
+
type: 'boolean',
|
|
1380
|
+
defaultValue: 'true'
|
|
1329
1381
|
}, {
|
|
1330
1382
|
name: 'children',
|
|
1331
1383
|
description: 'The content of the drawer.',
|
|
@@ -1337,11 +1389,13 @@ export var components = [{
|
|
|
1337
1389
|
}, {
|
|
1338
1390
|
name: 'isFocusLockEnabled',
|
|
1339
1391
|
description: 'Enable this to keep focus inside the component until it’s closed. This is strongly recommended, as it prevents people who use assistive technology from accidentally navigating out of the drawer using the tab key.',
|
|
1340
|
-
type: 'boolean'
|
|
1392
|
+
type: 'boolean',
|
|
1393
|
+
defaultValue: 'true'
|
|
1341
1394
|
}, {
|
|
1342
1395
|
name: 'isOpen',
|
|
1343
1396
|
description: 'Controls if the drawer is open or closed.',
|
|
1344
|
-
type: 'boolean'
|
|
1397
|
+
type: 'boolean',
|
|
1398
|
+
isRequired: true
|
|
1345
1399
|
}, {
|
|
1346
1400
|
name: 'label',
|
|
1347
1401
|
description: 'This is an `aria-label` attribute. It sets an accessible name for the drawer wrapper, for people who use assistive technology.\nUsage of either this, or the `titleId` attribute is strongly recommended.',
|
|
@@ -1365,7 +1419,8 @@ export var components = [{
|
|
|
1365
1419
|
}, {
|
|
1366
1420
|
name: 'shouldReturnFocus',
|
|
1367
1421
|
description: 'ReturnFocus controls what happens when the user exits focus lock mode.\nIf true, focus returns to the trigger element . If false, focus remains where it was when the FocusLock was deactivated.\nIf ref is passed, focus returns to that specific ref element.',
|
|
1368
|
-
type: 'boolean | React.RefObject<HTMLElement>'
|
|
1422
|
+
type: 'boolean | React.RefObject<HTMLElement>',
|
|
1423
|
+
defaultValue: 'true'
|
|
1369
1424
|
}, {
|
|
1370
1425
|
name: 'titleId',
|
|
1371
1426
|
description: "This is an ID referenced by the drawer wrapper's `aria-labelledby` attribute. This ID should be assigned to the drawer `title` element.\nUsage of either this, or the `label` attribute is strongly recommended.",
|
|
@@ -1373,11 +1428,13 @@ export var components = [{
|
|
|
1373
1428
|
}, {
|
|
1374
1429
|
name: 'width',
|
|
1375
1430
|
description: 'Sets the width of the drawer.',
|
|
1376
|
-
type: '"extended" | "full" | "medium" | "narrow" | "wide"'
|
|
1431
|
+
type: '"extended" | "full" | "medium" | "narrow" | "wide"',
|
|
1432
|
+
defaultValue: '"narrow"'
|
|
1377
1433
|
}, {
|
|
1378
1434
|
name: 'zIndex',
|
|
1379
1435
|
description: 'Z-index that the popup should be displayed in.\nThis is passed to the portal component.\nDefaults to `unset`.',
|
|
1380
|
-
type: 'number | "unset"'
|
|
1436
|
+
type: 'number | "unset"',
|
|
1437
|
+
defaultValue: '"unset"'
|
|
1381
1438
|
}]
|
|
1382
1439
|
}, {
|
|
1383
1440
|
name: 'DrawerContent',
|
|
@@ -1400,7 +1457,7 @@ export var components = [{
|
|
|
1400
1457
|
}, {
|
|
1401
1458
|
name: 'xcss',
|
|
1402
1459
|
description: '',
|
|
1403
|
-
type: 'false | (XCSSValue<"backgroundColor" | "marginTop" | "paddingBottom" | "paddingLeft" | "paddingRight" | "paddingTop" | "padding", DesignTokenStyles, ""> & ... 4 more ... & { ...; })'
|
|
1460
|
+
type: 'false | (XCSSValue<"backgroundColor" | "marginBlockStart" | "marginTop" | "paddingBlockEnd" | "paddingBlockStart" | "paddingBottom" | "paddingInlineEnd" | "paddingInlineStart" | "paddingLeft" | "paddingRight" | "paddingTop" | "padding", DesignTokenStyles, ""> & ... 4 more ... & { ...; })'
|
|
1404
1461
|
}]
|
|
1405
1462
|
}, {
|
|
1406
1463
|
name: 'DrawerSidebar',
|
|
@@ -1438,7 +1495,8 @@ export var components = [{
|
|
|
1438
1495
|
}, {
|
|
1439
1496
|
name: 'label',
|
|
1440
1497
|
description: 'This is the accessible name for the close/back control of the drawer. The default is "Close drawer".',
|
|
1441
|
-
type: 'string'
|
|
1498
|
+
type: 'string',
|
|
1499
|
+
defaultValue: '"Close drawer"'
|
|
1442
1500
|
}]
|
|
1443
1501
|
}, {
|
|
1444
1502
|
name: 'DropdownMenu',
|
|
@@ -1458,7 +1516,8 @@ export var components = [{
|
|
|
1458
1516
|
}, {
|
|
1459
1517
|
name: 'autoFocus',
|
|
1460
1518
|
description: 'Controls if the first menu item receives focus when menu is opened. Note that the menu has a focus lock\nwhich traps the focus within the menu. The first item gets focus automatically\nif the menu is triggered using the keyboard.',
|
|
1461
|
-
type: 'boolean'
|
|
1519
|
+
type: 'boolean',
|
|
1520
|
+
defaultValue: 'false'
|
|
1462
1521
|
}, {
|
|
1463
1522
|
name: 'children',
|
|
1464
1523
|
description: 'Content that will be rendered inside the layer element. Should typically be\n`DropdownItemGroup` or `DropdownItem`, or the checkbox and radio variants of those.',
|
|
@@ -1466,11 +1525,13 @@ export var components = [{
|
|
|
1466
1525
|
}, {
|
|
1467
1526
|
name: 'defaultOpen',
|
|
1468
1527
|
description: 'Controls the initial open state of the dropdown. If provided, the component is considered to be controlled\nwhich means that the user is responsible for managing the open and close state of the menu.\nUsing `defaultOpen` may cause accessiblity issues because it will automatically shift focus to the first menu item; which can be disorienting.\nOnly use this if action on the menu is required to proceed.',
|
|
1469
|
-
type: 'boolean'
|
|
1528
|
+
type: 'boolean',
|
|
1529
|
+
defaultValue: 'false'
|
|
1470
1530
|
}, {
|
|
1471
1531
|
name: 'isLoading',
|
|
1472
1532
|
description: 'If true, a spinner is rendered instead of the items.',
|
|
1473
|
-
type: 'boolean'
|
|
1533
|
+
type: 'boolean',
|
|
1534
|
+
defaultValue: 'false'
|
|
1474
1535
|
}, {
|
|
1475
1536
|
name: 'isOpen',
|
|
1476
1537
|
description: 'Controls the open state of the dropdown.',
|
|
@@ -1486,11 +1547,13 @@ export var components = [{
|
|
|
1486
1547
|
}, {
|
|
1487
1548
|
name: 'onOpenChange',
|
|
1488
1549
|
description: 'Called when the menu should be open/closed. Receives an object with `isOpen` state.\n\nIf the dropdown was closed programatically, the `event` parameter will be `null`.',
|
|
1489
|
-
type: '(args: OnOpenChangeArgs) => void'
|
|
1550
|
+
type: '(args: OnOpenChangeArgs) => void',
|
|
1551
|
+
defaultValue: 'noop'
|
|
1490
1552
|
}, {
|
|
1491
1553
|
name: 'placement',
|
|
1492
1554
|
description: 'Position of the menu.',
|
|
1493
|
-
type: '"auto-start" | "auto" | "auto-end" | "top-start" | "top" | "top-end" | "right-start" | "right" | "right-end" | "bottom-end" | "bottom" | "bottom-start" | "left-end" | "left" | "left-start"'
|
|
1555
|
+
type: '"auto-start" | "auto" | "auto-end" | "top-start" | "top" | "top-end" | "right-start" | "right" | "right-end" | "bottom-end" | "bottom" | "bottom-start" | "left-end" | "left" | "left-start"',
|
|
1556
|
+
defaultValue: '"bottom-start"'
|
|
1494
1557
|
}, {
|
|
1495
1558
|
name: 'returnFocusRef',
|
|
1496
1559
|
description: 'If ref is passed, focus returns to that specific ref element after dropdown dismissed.',
|
|
@@ -1498,15 +1561,23 @@ export var components = [{
|
|
|
1498
1561
|
}, {
|
|
1499
1562
|
name: 'shouldFitContainer',
|
|
1500
1563
|
description: "This fits the dropdown menu width to its parent's width.\nWhen set to `true`, the trigger and dropdown menu elements will be wrapped in a `div` with `position: relative`.\nThe dropdown menu will be rendered as a sibling to the trigger element, and will be full width.\nThe default is `false`.\n\nThis fits the dropdown menu width to its parent's width.\nWhen set to `true`, the trigger and dropdown menu elements will be wrapped in a `div` with `position: relative`.\nThe dropdown menu will be rendered as a sibling to the trigger element, and will be full width.\nThe default is `false`.",
|
|
1501
|
-
type: 'boolean'
|
|
1564
|
+
type: 'boolean',
|
|
1565
|
+
defaultValue: 'false'
|
|
1502
1566
|
}, {
|
|
1503
1567
|
name: 'shouldFlip',
|
|
1504
1568
|
description: 'Allows the dropdown menu to be placed on the opposite side of its trigger if it does not\nfit in the viewport.',
|
|
1505
|
-
type: 'boolean'
|
|
1569
|
+
type: 'boolean',
|
|
1570
|
+
defaultValue: 'true'
|
|
1571
|
+
}, {
|
|
1572
|
+
name: 'shouldPreventEscapePropagation',
|
|
1573
|
+
description: 'When set to true, will call stopPropagation on the ESCAPE key event.\nThis prevents the ESCAPE event from bubbling up to parent elements.',
|
|
1574
|
+
type: 'boolean',
|
|
1575
|
+
defaultValue: 'false'
|
|
1506
1576
|
}, {
|
|
1507
1577
|
name: 'shouldRenderToParent',
|
|
1508
1578
|
description: 'Controls whether the popup is rendered inline within its parent component or in a portal at the document root.\n`true` renders the dropdown menu in the DOM node closest to the trigger; focus is not trapped inside the element.\n`false` renders the dropdown menu in React.Portal and focus is trapped inside the element.\nDefaults to `false`.\nControls whether the popup is rendered inline within its parent component or in a portal at the document root.\n`true` renders the dropdown menu in the DOM node closest to the trigger; focus is not trapped inside the element.\n`false` renders the dropdown menu in React.Portal and focus is trapped inside the element.\nDefaults to `false`.',
|
|
1509
|
-
type: 'boolean'
|
|
1579
|
+
type: 'boolean',
|
|
1580
|
+
defaultValue: 'false'
|
|
1510
1581
|
}, {
|
|
1511
1582
|
name: 'spacing',
|
|
1512
1583
|
description: 'Controls the spacing density of the menu.',
|
|
@@ -1526,7 +1597,8 @@ export var components = [{
|
|
|
1526
1597
|
}, {
|
|
1527
1598
|
name: 'zIndex',
|
|
1528
1599
|
description: 'Z-index that the popup should be displayed in.\nThis is passed to the portal component.\nDefaults to `layers.modal()` from `@atlaskit/theme` which is 510.',
|
|
1529
|
-
type: 'number'
|
|
1600
|
+
type: 'number',
|
|
1601
|
+
defaultValue: '510'
|
|
1530
1602
|
}]
|
|
1531
1603
|
}, {
|
|
1532
1604
|
name: 'EmptyState',
|
|
@@ -1550,15 +1622,18 @@ export var components = [{
|
|
|
1550
1622
|
}, {
|
|
1551
1623
|
name: 'header',
|
|
1552
1624
|
description: 'Title that briefly describes the page to the user.',
|
|
1553
|
-
type: 'string'
|
|
1625
|
+
type: 'string',
|
|
1626
|
+
isRequired: true
|
|
1554
1627
|
}, {
|
|
1555
1628
|
name: 'headingLevel',
|
|
1556
1629
|
description: 'The value used to set the heading level of the header element.\nMust be in the range of 1 to 6. Defaults to 4.',
|
|
1557
|
-
type: 'number'
|
|
1630
|
+
type: 'number',
|
|
1631
|
+
defaultValue: '4'
|
|
1558
1632
|
}, {
|
|
1559
1633
|
name: 'headingSize',
|
|
1560
1634
|
description: 'The keyword used to set the visual appearance of the header element.\nDefaults to "medium". "xsmall" can be used for empty states in smaller contexts such as popups.',
|
|
1561
|
-
type: '"xsmall" | "medium"'
|
|
1635
|
+
type: '"xsmall" | "medium"',
|
|
1636
|
+
defaultValue: '"medium"'
|
|
1562
1637
|
}, {
|
|
1563
1638
|
name: 'imageHeight',
|
|
1564
1639
|
description: 'Height of the image that is rendered in EmptyState component.\nUseful when you want image to be of exact height to stop it bouncing around when loading in.\nOnly set `height` if you want the image to resize down on smaller devices.',
|
|
@@ -1578,11 +1653,13 @@ export var components = [{
|
|
|
1578
1653
|
}, {
|
|
1579
1654
|
name: 'maxImageHeight',
|
|
1580
1655
|
description: 'Maximum height (in pixels) of the image, default value is 160.',
|
|
1581
|
-
type: 'number'
|
|
1656
|
+
type: 'number',
|
|
1657
|
+
defaultValue: '160'
|
|
1582
1658
|
}, {
|
|
1583
1659
|
name: 'maxImageWidth',
|
|
1584
1660
|
description: 'Maximum width (in pixels) of the image, default value is 160.',
|
|
1585
|
-
type: 'number'
|
|
1661
|
+
type: 'number',
|
|
1662
|
+
defaultValue: '160'
|
|
1586
1663
|
}, {
|
|
1587
1664
|
name: 'primaryAction',
|
|
1588
1665
|
description: 'Primary action button for the page, usually it will be something like "Create" (or "Retry" for error pages).',
|
|
@@ -1634,7 +1711,7 @@ export var components = [{
|
|
|
1634
1711
|
}, {
|
|
1635
1712
|
name: 'description',
|
|
1636
1713
|
description: 'The secondary content shown below the flag title.',
|
|
1637
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
1714
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal'
|
|
1638
1715
|
}, {
|
|
1639
1716
|
name: 'headingLevel',
|
|
1640
1717
|
description: 'Specifies the heading level in the document structure.\nIf not specified, the default is `2`.',
|
|
@@ -1642,19 +1719,20 @@ export var components = [{
|
|
|
1642
1719
|
}, {
|
|
1643
1720
|
name: 'icon',
|
|
1644
1721
|
description: 'The icon displayed in the top-left of the flag. Should be an instance of `@atlaskit/icon`.\nYour icon will receive the appropriate default color, which you can override by setting\nthe `color` prop on the icon to your preferred icon color.\nIf no icon is provided, a default icon will be used based on the appearance prop.',
|
|
1645
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
1722
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal'
|
|
1646
1723
|
}, {
|
|
1647
1724
|
name: 'id',
|
|
1648
1725
|
description: 'A unique identifier used for rendering and onDismissed callbacks.',
|
|
1649
|
-
type: 'string | number'
|
|
1726
|
+
type: 'string | number',
|
|
1727
|
+
isRequired: true
|
|
1650
1728
|
}, {
|
|
1651
1729
|
name: 'linkComponent',
|
|
1652
1730
|
description: 'A link component that is passed down to the `@atlaskit/button` used by actions,\nto allow custom routers to be used. See the\n[button with router](https://atlaskit.atlassian.com/packages/design-system/button/example/ButtonWithRouter)\nexample of what this component should look like.',
|
|
1653
|
-
type: 'ComponentClass<CustomThemeButtonProps, any> | FunctionComponent<CustomThemeButtonProps>'
|
|
1731
|
+
type: 'React.ComponentClass<CustomThemeButtonProps, any> | React.FunctionComponent<CustomThemeButtonProps>'
|
|
1654
1732
|
}, {
|
|
1655
1733
|
name: 'onBlur',
|
|
1656
1734
|
description: 'Standard onBlur event, applied to Flag by AutoDismissFlag.',
|
|
1657
|
-
type: '(e: FocusEvent<HTMLElement, Element>, analyticsEvent: UIAnalyticsEvent) => void'
|
|
1735
|
+
type: '(e: React.FocusEvent<HTMLElement, Element>, analyticsEvent: UIAnalyticsEvent) => void'
|
|
1658
1736
|
}, {
|
|
1659
1737
|
name: 'onDismissed',
|
|
1660
1738
|
description: "Handler which will be called when a Flag's dismiss button is clicked.\nReceives the id of the dismissed Flag as a parameter.",
|
|
@@ -1662,19 +1740,20 @@ export var components = [{
|
|
|
1662
1740
|
}, {
|
|
1663
1741
|
name: 'onFocus',
|
|
1664
1742
|
description: 'Standard onFocus event, applied to Flag by AutoDismissFlag.',
|
|
1665
|
-
type: '(e: FocusEvent<HTMLElement, Element>, analyticsEvent: UIAnalyticsEvent) => void'
|
|
1743
|
+
type: '(e: React.FocusEvent<HTMLElement, Element>, analyticsEvent: UIAnalyticsEvent) => void'
|
|
1666
1744
|
}, {
|
|
1667
1745
|
name: 'onMouseOut',
|
|
1668
1746
|
description: 'Standard onMouseOut event, applied to Flag by AutoDismissFlag.',
|
|
1669
|
-
type: '(event: MouseEvent<Element,
|
|
1747
|
+
type: '(event: React.MouseEvent<Element, MouseEvent>) => void'
|
|
1670
1748
|
}, {
|
|
1671
1749
|
name: 'onMouseOver',
|
|
1672
1750
|
description: 'Standard onMouseOver event, applied to Flag by AutoDismissFlag.',
|
|
1673
|
-
type: '(event: MouseEvent<Element,
|
|
1751
|
+
type: '(event: React.MouseEvent<Element, MouseEvent>) => void'
|
|
1674
1752
|
}, {
|
|
1675
1753
|
name: 'title',
|
|
1676
1754
|
description: 'The bold text shown at the top of the flag.',
|
|
1677
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
1755
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal',
|
|
1756
|
+
isRequired: true
|
|
1678
1757
|
}]
|
|
1679
1758
|
}, {
|
|
1680
1759
|
name: 'Form',
|
|
@@ -1694,7 +1773,8 @@ export var components = [{
|
|
|
1694
1773
|
}, {
|
|
1695
1774
|
name: 'children',
|
|
1696
1775
|
description: 'The contents rendered inside of the form. This is a function where the props will be passed from the form. The function props you can access are `dirty`, `submitting` and `disabled`.\nYou can read more about these props in [react-final form documentation](https://final-form.org/docs/final-form/types/FormState).\n\nIf you are only spreading `formProps` onto the HTML `<form>` element and not using any of the other props (like `submitting`, etc.), `children` can be plain JSX. All of the children will be wrapped within an HTML `<form>` element that includes all necessary props, including those provided on the form component.',
|
|
1697
|
-
type: '(() => void) | React.ReactNode | ((args: FormChildrenArgs<FormValues>) => React.ReactNode)'
|
|
1776
|
+
type: '(() => void) | React.ReactNode | ((args: FormChildrenArgs<FormValues>) => React.ReactNode)',
|
|
1777
|
+
isRequired: true
|
|
1698
1778
|
}, {
|
|
1699
1779
|
name: 'formProps',
|
|
1700
1780
|
description: 'When `Form` renders JSX children directly and not using a function to\nspread `formProps` manually, the properties in this `formProps` prop will\nbe spread on an internally rendered HTML `form` element.',
|
|
@@ -1726,7 +1806,8 @@ export var components = [{
|
|
|
1726
1806
|
}, {
|
|
1727
1807
|
name: 'onSubmit',
|
|
1728
1808
|
description: 'Event handler called when the form is submitted. Fields must be free of validation errors.',
|
|
1729
|
-
type: '(values: FormValues, form: FormApi<FormValues>, callback?: (errors?: Record<string, string>) => void) => void | Object | Promise<...>'
|
|
1809
|
+
type: '(values: FormValues, form: FormApi<FormValues>, callback?: (errors?: Record<string, string>) => void) => void | Object | Promise<...>',
|
|
1810
|
+
isRequired: true
|
|
1730
1811
|
}, {
|
|
1731
1812
|
name: 'xcss',
|
|
1732
1813
|
description: 'Apply a subset of permitted styles powered by Atlassian Design System design tokens.',
|
|
@@ -1739,30 +1820,32 @@ export var components = [{
|
|
|
1739
1820
|
category: 'primitive',
|
|
1740
1821
|
description: 'A component for creating accessible, consistently styled headings with proper hierarchy. Headings are sized to contrast with content, increase visual hierarchy, and help readers easily understand the structure of content.',
|
|
1741
1822
|
status: 'general-availability',
|
|
1742
|
-
examples: ['import Heading from \'@atlaskit/heading\';\
|
|
1823
|
+
examples: ['import Heading from \'@atlaskit/heading\';\nconst _default_1: React.JSX.Element[] = [\n\t<Heading size="xxlarge">Page Title</Heading>,\n\t<Heading size="large" color="color.text.inverse">\n\t\tInverted section title\n\t</Heading>,\n];\nexport default _default_1;'],
|
|
1743
1824
|
accessibilityGuidelines: ['Maintain proper heading hierarchy (h1 to h6)', 'Use only one h1 per page for main page titles', 'Ensure minimum 4.5:1 color contrast for text readability', 'Use clear, descriptive heading text that describes the content below'],
|
|
1744
1825
|
usageGuidelines: ['Use the `HeadingContextProvider` offering to maintain heading levels in complex layouts', 'Maintain proper heading hierarchy', 'Keep headings concise and meaningful', 'Use sentence case for most headings', 'Use the `color` prop for inverse text on dark backgrounds', 'Do NOT use any inline styles, you must use the `size` (required) and `color` (optional) props available'],
|
|
1745
1826
|
contentGuidelines: ['Use clear, descriptive heading text', 'Maintain proper heading hierarchy', 'Keep headings concise and meaningful', 'Use sentence case for most headings', 'Make headings descriptive of the content that follows'],
|
|
1746
1827
|
props: [{
|
|
1747
1828
|
name: 'as',
|
|
1748
|
-
description: 'Allows the component to be rendered as the specified
|
|
1829
|
+
description: 'Allows the component to be rendered as the specified HTML element, overriding a default element set by the `size` prop.',
|
|
1749
1830
|
type: '"h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "div" | "span"'
|
|
1750
1831
|
}, {
|
|
1751
1832
|
name: 'children',
|
|
1752
1833
|
description: 'The text of the heading.',
|
|
1753
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
1834
|
+
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal',
|
|
1835
|
+
isRequired: true
|
|
1754
1836
|
}, {
|
|
1755
1837
|
name: 'color',
|
|
1756
1838
|
description: 'Token representing text color with a built-in fallback value.\nWill apply inverse text color automatically if placed within a Box with bold background color.\nDefaults to `color.text`.',
|
|
1757
1839
|
type: '"color.text" | "color.text.inverse" | "color.text.warning.inverse"'
|
|
1758
1840
|
}, {
|
|
1759
1841
|
name: 'id',
|
|
1760
|
-
description: 'Unique identifier for the heading
|
|
1842
|
+
description: 'Unique identifier for the heading HTML element.',
|
|
1761
1843
|
type: 'string'
|
|
1762
1844
|
}, {
|
|
1763
1845
|
name: 'size',
|
|
1764
|
-
description: '
|
|
1765
|
-
type: '"xxlarge" | "xlarge" | "large" | "medium" | "small" | "xsmall" | "xxsmall"'
|
|
1846
|
+
description: 'Determines which text styles are applied. A corresponding HTML element is automatically applied from h1 to h6 based on the size.\nThis can be overriden using the `as` prop to allow for more flexibility.',
|
|
1847
|
+
type: '"xxlarge" | "xlarge" | "large" | "medium" | "small" | "xsmall" | "xxsmall"',
|
|
1848
|
+
isRequired: true
|
|
1766
1849
|
}]
|
|
1767
1850
|
}, {
|
|
1768
1851
|
name: 'HeadingContextProvider',
|
|
@@ -1771,13 +1854,14 @@ export var components = [{
|
|
|
1771
1854
|
category: 'primitive',
|
|
1772
1855
|
description: 'A context provider that allows you to configure the default HTML heading level for all headings within its subtree. Useful for maintaining proper heading hierarchy in complex layouts.',
|
|
1773
1856
|
status: 'general-availability',
|
|
1774
|
-
examples: ['import Heading, { HeadingContextProvider } from \'@atlaskit/heading\';\
|
|
1857
|
+
examples: ['import Heading, { HeadingContextProvider } from \'@atlaskit/heading\';\nconst _default_1: React.JSX.Element[] = [\n\t<HeadingContextProvider>\n\t\t<Heading size="xxlarge">h1</Heading>\n\t\t<Heading size="medium">h2</Heading>\n\t\t<Heading size="large">h3</Heading>\n\t</HeadingContextProvider>,\n];\nexport default _default_1;'],
|
|
1775
1858
|
usageGuidelines: ['Wrap sections that need different heading hierarchy', 'Use for complex layouts where heading levels need adjustment'],
|
|
1776
1859
|
contentGuidelines: ['Ensure proper heading hierarchy is maintained', 'Use clear, descriptive heading text', 'Keep headings concise and meaningful'],
|
|
1777
1860
|
props: [{
|
|
1778
1861
|
name: 'children',
|
|
1779
1862
|
description: 'Semantic hierarchy of content below the heading context.',
|
|
1780
|
-
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal'
|
|
1863
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal',
|
|
1864
|
+
isRequired: true
|
|
1781
1865
|
}, {
|
|
1782
1866
|
name: 'value',
|
|
1783
1867
|
description: 'Optional - only apply this value if the intent is to reset the heading context outside the normal content flow, for example inside a `section`.',
|
|
@@ -1790,7 +1874,7 @@ export var components = [{
|
|
|
1790
1874
|
category: 'images-and-icons',
|
|
1791
1875
|
description: 'An icon is a symbol representing a command, device, directory, or common action.',
|
|
1792
1876
|
status: 'general-availability',
|
|
1793
|
-
examples: ["import AddIcon from '@atlaskit/icon/core/add';\nimport DeleteIcon from '@atlaskit/icon/core/delete';\nimport StarIcon from '@atlaskit/icon/core/star-starred';\nimport { token } from '@atlaskit/tokens';\
|
|
1877
|
+
examples: ["import AddIcon from '@atlaskit/icon/core/add';\nimport DeleteIcon from '@atlaskit/icon/core/delete';\nimport StarIcon from '@atlaskit/icon/core/star-starred';\nimport { token } from '@atlaskit/tokens';\nconst _default_1: React.JSX.Element[] = [\n\t<AddIcon label=\"Add\" />,\n\t<StarIcon label=\"Star\" color=\"currentColor\" />,\n\t<DeleteIcon label=\"Delete\" color={token('color.icon.danger')} />,\n];\nexport default _default_1;"],
|
|
1794
1878
|
accessibilityGuidelines: ['Provide appropriate alt text or labels for icons', 'Use meaningful icon choices that convey clear meaning', 'Ensure sufficient color contrast for icon visibility', 'Consider icon size for touch targets', 'Use consistent iconography across the interface'],
|
|
1795
1879
|
usageGuidelines: ['Use icons to enhance visual communication', 'Choose icons that clearly represent their function', 'Maintain consistent icon style and size', 'Use appropriate icon sizes for different contexts', 'Consider cultural and contextual icon meanings'],
|
|
1796
1880
|
contentGuidelines: ['Use clear, recognizable icon symbols', 'Ensure icons are culturally appropriate', 'Maintain visual consistency across icon sets', 'Use appropriate icon labels and descriptions'],
|
|
@@ -1809,7 +1893,8 @@ export var components = [{
|
|
|
1809
1893
|
}, {
|
|
1810
1894
|
name: 'label',
|
|
1811
1895
|
description: 'Text used to describe what the icon is in context.',
|
|
1812
|
-
type: 'string'
|
|
1896
|
+
type: 'string',
|
|
1897
|
+
isRequired: true
|
|
1813
1898
|
}, {
|
|
1814
1899
|
name: 'primaryColor',
|
|
1815
1900
|
description: 'Primary color for the icon.\nInherits the current font color by default.',
|
|
@@ -1830,22 +1915,25 @@ export var components = [{
|
|
|
1830
1915
|
category: 'images-and-icons',
|
|
1831
1916
|
description: 'A tile component that displays an icon with customizable background, shape, and appearance.',
|
|
1832
1917
|
status: 'release-candidate',
|
|
1833
|
-
examples: ['import { IconTile } from \'@atlaskit/icon\';\nimport AddIcon from \'@atlaskit/icon/core/add\';\
|
|
1918
|
+
examples: ['import { IconTile } from \'@atlaskit/icon\';\nimport AddIcon from \'@atlaskit/icon/core/add\';\nconst _default_1: React.JSX.Element[] = [\n\t<IconTile icon={AddIcon} label="Add" appearance="redBold" />,\n\t<IconTile icon={AddIcon} label="Add" shape="circle" appearance="blue" />,\n];\nexport default _default_1;'],
|
|
1834
1919
|
accessibilityGuidelines: ['Provide appropriate labels for icon tiles', 'Ensure sufficient color contrast', 'Use meaningful icon choices', 'Consider touch target sizes'],
|
|
1835
1920
|
usageGuidelines: ['Use for icon presentation with background styling', 'Choose appropriate shapes and appearances', 'Maintain consistent sizing across tiles', 'Use for visual emphasis or categorization'],
|
|
1836
1921
|
contentGuidelines: ['Use clear, recognizable icons', 'Choose appropriate colors and shapes', 'Ensure visual consistency across tiles'],
|
|
1837
1922
|
props: [{
|
|
1838
1923
|
name: 'appearance',
|
|
1839
1924
|
description: 'The appearance of the tile',
|
|
1840
|
-
type: '"gray" | "blue" | "teal" | "green" | "lime" | "yellow" | "orange" | "red" | "magenta" | "purple" | "grayBold" | "blueBold" | "tealBold" | "greenBold" | "limeBold" | "yellowBold" | "orangeBold" | "redBold" | "magentaBold" | "purpleBold"'
|
|
1925
|
+
type: '"gray" | "blue" | "teal" | "green" | "lime" | "yellow" | "orange" | "red" | "magenta" | "purple" | "grayBold" | "blueBold" | "tealBold" | "greenBold" | "limeBold" | "yellowBold" | "orangeBold" | "redBold" | "magentaBold" | "purpleBold"',
|
|
1926
|
+
isRequired: true
|
|
1841
1927
|
}, {
|
|
1842
1928
|
name: 'icon',
|
|
1843
1929
|
description: 'The icon to display',
|
|
1844
|
-
type: 'React.ComponentClass<NewCoreIconProps, any> | React.FunctionComponent<NewCoreIconProps>'
|
|
1930
|
+
type: 'React.ComponentClass<NewCoreIconProps, any> | React.FunctionComponent<NewCoreIconProps>',
|
|
1931
|
+
isRequired: true
|
|
1845
1932
|
}, {
|
|
1846
1933
|
name: 'label',
|
|
1847
1934
|
description: 'The label for the icon',
|
|
1848
|
-
type: 'string'
|
|
1935
|
+
type: 'string',
|
|
1936
|
+
isRequired: true
|
|
1849
1937
|
}, {
|
|
1850
1938
|
name: 'size',
|
|
1851
1939
|
description: 'Size of the tile, in pixels. Defaults to `24`.\n\nNow supports both semantic t-shirt size names and pixel number values. Pixel number values are deprecated and will be removed in a future release, however they will both be available and backwards-compatible during a transition period.\n\nSize `16` will not have a replacement after deprecation, and should be replaced with direct icons without a tile or enlarging to the next available size `xsmall`.\n\nAll available sizes:\n- `16` (deprecated)\n- `xsmall` (new)\n- `small` or `24`\n- `medium` or `32`\n- `large` or `40`\n- `xlarge` or `48`',
|
|
@@ -1885,11 +1973,13 @@ export var components = [{
|
|
|
1885
1973
|
props: [{
|
|
1886
1974
|
name: 'children',
|
|
1887
1975
|
description: 'The elements that the InlineDialog will be positioned relative to.',
|
|
1888
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
1976
|
+
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal',
|
|
1977
|
+
isRequired: true
|
|
1889
1978
|
}, {
|
|
1890
1979
|
name: 'content',
|
|
1891
1980
|
description: 'The elements to be displayed within the InlineDialog.',
|
|
1892
|
-
type: 'ReactNode | (() => ReactNode)'
|
|
1981
|
+
type: 'ReactNode | (() => ReactNode)',
|
|
1982
|
+
isRequired: true
|
|
1893
1983
|
}, {
|
|
1894
1984
|
name: 'fallbackPlacements',
|
|
1895
1985
|
description: "This is a list of backup placements to try.\nWhen the preferred placement doesn't have enough space,\nthe modifier will test the ones provided in the list, and use the first suitable one.\nIf no fallback placements are suitable, it reverts back to the original placement.",
|
|
@@ -1945,7 +2035,8 @@ export var components = [{
|
|
|
1945
2035
|
}, {
|
|
1946
2036
|
name: 'defaultValue',
|
|
1947
2037
|
description: 'The user input entered into the field during `editView`. This value is updated and saved by `onConfirm`.',
|
|
1948
|
-
type: 'any'
|
|
2038
|
+
type: 'any',
|
|
2039
|
+
isRequired: true
|
|
1949
2040
|
}, {
|
|
1950
2041
|
name: 'editButtonLabel',
|
|
1951
2042
|
description: 'Accessibility label for button, which is used to enter `editView` from keyboard.',
|
|
@@ -1957,7 +2048,8 @@ export var components = [{
|
|
|
1957
2048
|
}, {
|
|
1958
2049
|
name: 'editView',
|
|
1959
2050
|
description: 'The component shown when user is editing (when the inline edit is not in `readView`).',
|
|
1960
|
-
type: '(fieldProps: ExtendedFieldProps<FieldValue>, ref: React.RefObject<any>) => React.ReactNode'
|
|
2051
|
+
type: '(fieldProps: ExtendedFieldProps<FieldValue>, ref: React.RefObject<any>) => React.ReactNode',
|
|
2052
|
+
isRequired: true
|
|
1961
2053
|
}, {
|
|
1962
2054
|
name: 'hideActionButtons',
|
|
1963
2055
|
description: 'Sets whether the confirm and cancel action buttons are displayed in the bottom right of the field.',
|
|
@@ -1985,7 +2077,8 @@ export var components = [{
|
|
|
1985
2077
|
}, {
|
|
1986
2078
|
name: 'onConfirm',
|
|
1987
2079
|
description: 'Saves and confirms the value entered into the field. It exits `editView` and returns to `readView`.',
|
|
1988
|
-
type: '(value: any, analyticsEvent: UIAnalyticsEvent) => void'
|
|
2080
|
+
type: '(value: any, analyticsEvent: UIAnalyticsEvent) => void',
|
|
2081
|
+
isRequired: true
|
|
1989
2082
|
}, {
|
|
1990
2083
|
name: 'onEdit',
|
|
1991
2084
|
description: 'Handler called when readView is clicked.',
|
|
@@ -1993,7 +2086,8 @@ export var components = [{
|
|
|
1993
2086
|
}, {
|
|
1994
2087
|
name: 'readView',
|
|
1995
2088
|
description: 'The component shown when not in `editView`. This is when the inline edit is read-only and not being edited.',
|
|
1996
|
-
type: '() => React.ReactNode'
|
|
2089
|
+
type: '() => React.ReactNode',
|
|
2090
|
+
isRequired: true
|
|
1997
2091
|
}, {
|
|
1998
2092
|
name: 'readViewFitContainerWidth',
|
|
1999
2093
|
description: 'Determines whether the `readView` has 100% width within its container, or whether it fits the content.',
|
|
@@ -2021,15 +2115,16 @@ export var components = [{
|
|
|
2021
2115
|
props: [{
|
|
2022
2116
|
name: 'appearance',
|
|
2023
2117
|
description: 'Set the icon to be used before the title. Options are: connectivity,\nconfirmation, info, warning, and error.',
|
|
2024
|
-
type: '"connectivity" | "confirmation" | "info" | "warning" | "error"'
|
|
2118
|
+
type: '"connectivity" | "confirmation" | "info" | "warning" | "error"',
|
|
2119
|
+
defaultValue: '"connectivity"'
|
|
2025
2120
|
}, {
|
|
2026
2121
|
name: 'children',
|
|
2027
2122
|
description: 'The elements to be displayed by the popup.',
|
|
2028
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
2123
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.ReactPortal'
|
|
2029
2124
|
}, {
|
|
2030
2125
|
name: 'fallbackPlacements',
|
|
2031
2126
|
description: "This is a list of backup placements for the popup to try.\nWhen the preferred placement doesn't have enough space,\nthe modifier will test the ones provided in the list, and use the first suitable one.\nIf no fallback placements are suitable, it reverts back to the original placement.",
|
|
2032
|
-
type: '
|
|
2127
|
+
type: 'PopupPlacement[]'
|
|
2033
2128
|
}, {
|
|
2034
2129
|
name: 'iconLabel',
|
|
2035
2130
|
description: 'Text to be used as the label for the button icon. You must use this to provide information for people who use assistive technology when there is no title and/or secondaryText.',
|
|
@@ -2037,19 +2132,23 @@ export var components = [{
|
|
|
2037
2132
|
}, {
|
|
2038
2133
|
name: 'placement',
|
|
2039
2134
|
description: 'The placement to be passed to the popup. Determines where around\nthe text the dialog is displayed.',
|
|
2040
|
-
type: 'AutoPlacement | BasePlacement | VariationPlacement'
|
|
2135
|
+
type: 'AutoPlacement | BasePlacement | VariationPlacement',
|
|
2136
|
+
defaultValue: '"bottom-start"'
|
|
2041
2137
|
}, {
|
|
2042
2138
|
name: 'secondaryText',
|
|
2043
2139
|
description: 'Text to display second.',
|
|
2044
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
2140
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.ReactPortal',
|
|
2141
|
+
defaultValue: '""'
|
|
2045
2142
|
}, {
|
|
2046
2143
|
name: 'spacing',
|
|
2047
2144
|
description: 'The spacing of the underlying icon button. Options are: spacious and compact.',
|
|
2048
|
-
type: '"spacious" | "compact"'
|
|
2145
|
+
type: '"spacious" | "compact"',
|
|
2146
|
+
defaultValue: '"spacious"'
|
|
2049
2147
|
}, {
|
|
2050
2148
|
name: 'title',
|
|
2051
2149
|
description: 'Text to display first, bolded for emphasis.',
|
|
2052
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
2150
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.ReactPortal',
|
|
2151
|
+
defaultValue: '""'
|
|
2053
2152
|
}]
|
|
2054
2153
|
}, {
|
|
2055
2154
|
name: 'Link',
|
|
@@ -2058,7 +2157,7 @@ export var components = [{
|
|
|
2058
2157
|
category: 'navigation',
|
|
2059
2158
|
description: 'A component for navigation links.',
|
|
2060
2159
|
status: 'general-availability',
|
|
2061
|
-
examples: ['import Link from \'@atlaskit/link\';\
|
|
2160
|
+
examples: ['import Link from \'@atlaskit/link\';\nconst _default_1: React.JSX.Element[] = [\n\t<Link href="/dashboard">Go to Dashboard</Link>,\n\t<Link href="https://atlassian.design" target="_blank">\n\t\tAtlassian Design System\n\t</Link>,\n];\nexport default _default_1;'],
|
|
2062
2161
|
accessibilityGuidelines: ['Provide clear link text that describes the destination', 'Use appropriate ARIA attributes for links', 'Ensure keyboard navigation support', 'Provide clear visual indicators for link state'],
|
|
2063
2162
|
usageGuidelines: ['Use for navigation to other pages or sections', 'Provide clear link text', 'Consider link behavior and target attributes', 'Use appropriate link styling'],
|
|
2064
2163
|
contentGuidelines: ['Use clear, descriptive link text', 'Maintain consistent link styling', 'Consider link context and destination', "Avoid generic text like 'click here'"],
|
|
@@ -2073,7 +2172,8 @@ export var components = [{
|
|
|
2073
2172
|
}, {
|
|
2074
2173
|
name: 'href',
|
|
2075
2174
|
description: 'Standard links can be provided as a string, which should be mapped to the\nunderlying router link component.\n\nAlternatively, you can provide an object for advanced link configurations\nby supplying the expected object type to the generic.\n\n@example\n```\nconst MyRouterLink = forwardRef(\n(\n {\n href,\n children,\n ...rest\n }: RouterLinkComponentProps<{\n href: string;\n replace: boolean;\n }>,\n ref: Ref<HTMLAnchorElement>,\n) => { ...\n```',
|
|
2076
|
-
type: 'string | RouterLinkConfig'
|
|
2175
|
+
type: 'string | RouterLinkConfig',
|
|
2176
|
+
isRequired: true
|
|
2077
2177
|
}, {
|
|
2078
2178
|
name: 'newWindowLabel',
|
|
2079
2179
|
description: 'Override the default text to signify that a link opens in a new window.\nThis is appended to the `aria-label` attribute when the `target` prop is set to `_blank`.',
|
|
@@ -2090,7 +2190,7 @@ export var components = [{
|
|
|
2090
2190
|
category: 'brand',
|
|
2091
2191
|
description: 'A component for displaying the Atlassian icon.',
|
|
2092
2192
|
status: 'general-availability',
|
|
2093
|
-
examples: ['import { AtlassianIcon } from \'@atlaskit/logo\';\
|
|
2193
|
+
examples: ['import { AtlassianIcon } from \'@atlaskit/logo\';\nconst _default_1: React.JSX.Element[] = [\n\t<AtlassianIcon appearance="brand" shouldUseNewLogoDesign />,\n\t<AtlassianIcon appearance="neutral" shouldUseNewLogoDesign />,\n];\nexport default _default_1;'],
|
|
2094
2194
|
accessibilityGuidelines: ['Provide appropriate alt text for the icon', 'Ensure icon visibility and contrast', 'Consider icon sizing and placement', 'Use appropriate icon variants'],
|
|
2095
2195
|
usageGuidelines: ['Use for Atlassian brand representation', 'Choose appropriate icon variants', 'Consider icon sizing and placement', 'Maintain brand consistency'],
|
|
2096
2196
|
props: [{
|
|
@@ -2100,7 +2200,8 @@ export var components = [{
|
|
|
2100
2200
|
}, {
|
|
2101
2201
|
name: 'label',
|
|
2102
2202
|
description: "Accessible text to be used for screen readers (it's optional since the default props provide a label that matches the logo).",
|
|
2103
|
-
type: 'string'
|
|
2203
|
+
type: 'string',
|
|
2204
|
+
defaultValue: '"Atlassian"'
|
|
2104
2205
|
}, {
|
|
2105
2206
|
name: 'shouldUseNewLogoDesign',
|
|
2106
2207
|
description: 'For logos that support it, enables the new logo design ahead of an upcoming feature flag roll-out.',
|
|
@@ -2108,7 +2209,8 @@ export var components = [{
|
|
|
2108
2209
|
}, {
|
|
2109
2210
|
name: 'size',
|
|
2110
2211
|
description: 'The size of the icon.',
|
|
2111
|
-
type: '"xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge"'
|
|
2212
|
+
type: '"xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge"',
|
|
2213
|
+
defaultValue: 'defaultLogoParams.size'
|
|
2112
2214
|
}]
|
|
2113
2215
|
}, {
|
|
2114
2216
|
name: 'Lozenge',
|
|
@@ -2123,8 +2225,8 @@ export var components = [{
|
|
|
2123
2225
|
contentGuidelines: ['Use clear, concise text', 'Ensure text is meaningful and descriptive', 'Use consistent terminology across lozenges', 'Consider text length and readability'],
|
|
2124
2226
|
props: [{
|
|
2125
2227
|
name: 'appearance',
|
|
2126
|
-
description: 'The appearance type.\nThe appearance of the lozenge. Supports
|
|
2127
|
-
type: 'ThemeAppearance | "warning" | "danger" | "information" | "neutral" | "discovery" |
|
|
2228
|
+
description: 'The appearance type.\nThe appearance of the lozenge. Supports legacy semantic appearances and new semantic colors.\nAccent appearance values.',
|
|
2229
|
+
type: 'ThemeAppearance | "warning" | "danger" | "information" | "neutral" | "discovery" | AccentColor'
|
|
2128
2230
|
}, {
|
|
2129
2231
|
name: 'children',
|
|
2130
2232
|
description: 'Elements to be rendered inside the lozenge. This should ideally be just a word or two.\nElements to be rendered inside the lozenge. This should ideally be just a word or two.',
|
|
@@ -2148,7 +2250,8 @@ export var components = [{
|
|
|
2148
2250
|
props: [{
|
|
2149
2251
|
name: 'children',
|
|
2150
2252
|
description: 'Children of the menu group.\nThis should generally be `Section` components.',
|
|
2151
|
-
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal'
|
|
2253
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal',
|
|
2254
|
+
isRequired: true
|
|
2152
2255
|
}, {
|
|
2153
2256
|
name: 'isLoading',
|
|
2154
2257
|
description: 'Used this to tell assistive technologies that the menu group is loading.',
|
|
@@ -2184,7 +2287,8 @@ export var components = [{
|
|
|
2184
2287
|
}, {
|
|
2185
2288
|
name: 'spacing',
|
|
2186
2289
|
description: 'Configure the density of the menu group content.',
|
|
2187
|
-
type: '"
|
|
2290
|
+
type: '"cozy" | "compact"',
|
|
2291
|
+
defaultValue: '"cozy"'
|
|
2188
2292
|
}]
|
|
2189
2293
|
}, {
|
|
2190
2294
|
name: 'Modal',
|
|
@@ -2288,7 +2392,8 @@ export var components = [{
|
|
|
2288
2392
|
}, {
|
|
2289
2393
|
name: 'disableTitleStyles',
|
|
2290
2394
|
description: 'Content of the page title. The text wraps by default.',
|
|
2291
|
-
type: 'boolean'
|
|
2395
|
+
type: 'boolean',
|
|
2396
|
+
defaultValue: 'false'
|
|
2292
2397
|
}, {
|
|
2293
2398
|
name: 'id',
|
|
2294
2399
|
description: 'Used as the ID of the inner h1 tag. This is exposed so the header text can be used as label of other elements by aria-labelledby.',
|
|
@@ -2300,7 +2405,8 @@ export var components = [{
|
|
|
2300
2405
|
}, {
|
|
2301
2406
|
name: 'truncateTitle',
|
|
2302
2407
|
description: 'Prevent the title from wrapping across lines. Avoid using this wherever possible, as truncation can make page headings inaccessible.',
|
|
2303
|
-
type: 'boolean'
|
|
2408
|
+
type: 'boolean',
|
|
2409
|
+
defaultValue: 'false'
|
|
2304
2410
|
}]
|
|
2305
2411
|
}, {
|
|
2306
2412
|
name: 'Pagination',
|
|
@@ -2316,7 +2422,7 @@ export var components = [{
|
|
|
2316
2422
|
props: [{
|
|
2317
2423
|
name: 'components',
|
|
2318
2424
|
description: 'Replace the built-in page, previous, next and/ or ellipsis component',
|
|
2319
|
-
type: '{ Page?: React.ElementType<any>; Previous?: React.ElementType<any>; Next?: React.ElementType
|
|
2425
|
+
type: '{ Page?: React.ElementType<any, keyof React.JSX.IntrinsicElements>; Previous?: React.ElementType<any, keyof React.JSX.IntrinsicElements>; Next?: React.ElementType<...>; }'
|
|
2320
2426
|
}, {
|
|
2321
2427
|
name: 'defaultSelectedIndex',
|
|
2322
2428
|
description: 'Index of the page to be selected by default.',
|
|
@@ -2352,7 +2458,8 @@ export var components = [{
|
|
|
2352
2458
|
}, {
|
|
2353
2459
|
name: 'pages',
|
|
2354
2460
|
description: 'Array of the pages to display.',
|
|
2355
|
-
type: 'T[]'
|
|
2461
|
+
type: 'T[]',
|
|
2462
|
+
isRequired: true
|
|
2356
2463
|
}, {
|
|
2357
2464
|
name: 'previousLabel',
|
|
2358
2465
|
description: 'The aria-label for the previous button.\nThe default value is "previous".',
|
|
@@ -2380,7 +2487,8 @@ export var components = [{
|
|
|
2380
2487
|
props: [{
|
|
2381
2488
|
name: 'children',
|
|
2382
2489
|
description: 'Returns the element to be positioned.',
|
|
2383
|
-
type: '(childrenProps: PopperChildrenProps) => React.ReactNode'
|
|
2490
|
+
type: '(childrenProps: PopperChildrenProps) => React.ReactNode',
|
|
2491
|
+
defaultValue: 'defaultChildrenFn'
|
|
2384
2492
|
}, {
|
|
2385
2493
|
name: 'modifiers',
|
|
2386
2494
|
description: 'Additional modifiers and modifier overwrites.',
|
|
@@ -2388,23 +2496,28 @@ export var components = [{
|
|
|
2388
2496
|
}, {
|
|
2389
2497
|
name: 'offset',
|
|
2390
2498
|
description: 'Distance the popup should be offset from the reference in the format of [along, away] (units in px).\nDefaults to [0, 8] - which means the popup will be 8px away from the edge of the reference specified\nby the `placement` prop.',
|
|
2391
|
-
type: '[number, number]'
|
|
2499
|
+
type: '[number, number]',
|
|
2500
|
+
defaultValue: 'defaultOffset'
|
|
2392
2501
|
}, {
|
|
2393
2502
|
name: 'placement',
|
|
2394
2503
|
description: 'Which side of the Reference to show on.',
|
|
2395
|
-
type: 'AutoPlacement | BasePlacement | VariationPlacement'
|
|
2504
|
+
type: 'AutoPlacement | BasePlacement | VariationPlacement',
|
|
2505
|
+
defaultValue: '"bottom-start"'
|
|
2396
2506
|
}, {
|
|
2397
2507
|
name: 'referenceElement',
|
|
2398
2508
|
description: 'Replacement reference element to position popper relative to.',
|
|
2399
|
-
type: 'HTMLElement | VirtualElement'
|
|
2509
|
+
type: 'HTMLElement | VirtualElement',
|
|
2510
|
+
defaultValue: 'undefined'
|
|
2400
2511
|
}, {
|
|
2401
2512
|
name: 'shouldFitViewport',
|
|
2402
2513
|
description: 'Determines if the popper will have a `max-width` and `max-height` set to\nconstrain it to the viewport.',
|
|
2403
|
-
type: 'boolean'
|
|
2514
|
+
type: 'boolean',
|
|
2515
|
+
defaultValue: 'false'
|
|
2404
2516
|
}, {
|
|
2405
2517
|
name: 'strategy',
|
|
2406
2518
|
description: "Placement strategy used. Can be 'fixed' or 'absolute'",
|
|
2407
|
-
type: '"fixed" | "absolute"'
|
|
2519
|
+
type: '"fixed" | "absolute"',
|
|
2520
|
+
defaultValue: '"fixed"'
|
|
2408
2521
|
}]
|
|
2409
2522
|
}, {
|
|
2410
2523
|
name: 'Popup',
|
|
@@ -2432,7 +2545,8 @@ export var components = [{
|
|
|
2432
2545
|
}, {
|
|
2433
2546
|
name: 'content',
|
|
2434
2547
|
description: 'Render props for content that is displayed inside the popup.',
|
|
2435
|
-
type: '(props: ContentProps) => ReactNode'
|
|
2548
|
+
type: '(props: ContentProps) => ReactNode',
|
|
2549
|
+
isRequired: true
|
|
2436
2550
|
}, {
|
|
2437
2551
|
name: 'fallbackPlacements',
|
|
2438
2552
|
description: "This is a list of backup placements for the popup to try.\nWhen the preferred placement doesn't have enough space,\nthe modifier will test the ones provided in the list, and use the first suitable one.\nIf no fallback placements are suitable, it reverts back to the original placement.",
|
|
@@ -2444,7 +2558,8 @@ export var components = [{
|
|
|
2444
2558
|
}, {
|
|
2445
2559
|
name: 'isOpen',
|
|
2446
2560
|
description: 'Use this to either show or hide the popup.\nWhen set to `false` the popup will not render anything to the DOM.',
|
|
2447
|
-
type: 'boolean'
|
|
2561
|
+
type: 'boolean',
|
|
2562
|
+
isRequired: true
|
|
2448
2563
|
}, {
|
|
2449
2564
|
name: 'label',
|
|
2450
2565
|
description: 'Refers to an `aria-label` attribute. Sets an accessible name for the popup to announce it to users of assistive technology.\nUsage of either this, or the `titleId` attribute is strongly recommended.',
|
|
@@ -2516,7 +2631,8 @@ export var components = [{
|
|
|
2516
2631
|
}, {
|
|
2517
2632
|
name: 'trigger',
|
|
2518
2633
|
description: 'Render props used to anchor the popup to your content.\nMake this an interactive element,\nsuch as an `@atlaskit/button` component.',
|
|
2519
|
-
type: '(props: TriggerProps) => ReactNode'
|
|
2634
|
+
type: '(props: TriggerProps) => ReactNode',
|
|
2635
|
+
isRequired: true
|
|
2520
2636
|
}, {
|
|
2521
2637
|
name: 'xcss',
|
|
2522
2638
|
description: 'Bounded style overrides.',
|
|
@@ -2540,15 +2656,18 @@ export var components = [{
|
|
|
2540
2656
|
props: [{
|
|
2541
2657
|
name: 'children',
|
|
2542
2658
|
description: '',
|
|
2543
|
-
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal'
|
|
2659
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal',
|
|
2660
|
+
isRequired: true
|
|
2544
2661
|
}, {
|
|
2545
2662
|
name: 'mountStrategy',
|
|
2546
2663
|
description: 'Specify the mount strategy: useEffect or useLayoutEffect.\nNote: UseLayoutEffect can lead to performance issues and is discouraged.',
|
|
2547
|
-
type: '"effect" | "layoutEffect"'
|
|
2664
|
+
type: '"effect" | "layoutEffect"',
|
|
2665
|
+
defaultValue: '"effect"'
|
|
2548
2666
|
}, {
|
|
2549
2667
|
name: 'zIndex',
|
|
2550
2668
|
description: '',
|
|
2551
|
-
type: 'string | number'
|
|
2669
|
+
type: 'string | number',
|
|
2670
|
+
defaultValue: '0'
|
|
2552
2671
|
}]
|
|
2553
2672
|
}, {
|
|
2554
2673
|
name: 'Anchor',
|
|
@@ -2557,7 +2676,7 @@ export var components = [{
|
|
|
2557
2676
|
category: 'primitive',
|
|
2558
2677
|
description: 'A primitive Anchor component for navigation links with compiled styling support.',
|
|
2559
2678
|
status: 'general-availability',
|
|
2560
|
-
examples: ['import { Anchor } from \'@atlaskit/primitives/compiled\';\
|
|
2679
|
+
examples: ['import { Anchor } from \'@atlaskit/primitives/compiled\';\nconst _default_1: React.JSX.Element[] = [\n\t<Anchor href="https://atlassian.design">Atlassian Design System</Anchor>,\n\t<Anchor href="/docs" target="_blank">\n\t\tOpen docs\n\t</Anchor>,\n];\nexport default _default_1;'],
|
|
2561
2680
|
accessibilityGuidelines: ['Provide clear link text that describes the destination', 'Use appropriate ARIA attributes for links', 'Ensure keyboard navigation support', 'Provide clear visual indicators for link state', 'Use descriptive link text for screen readers'],
|
|
2562
2681
|
usageGuidelines: ['Use for navigation links to other pages or sections', 'Leverage compiled styling for performance', 'Use appropriate link styling and states', 'Consider link behavior and target attributes'],
|
|
2563
2682
|
contentGuidelines: ['Use clear, descriptive link text', 'Maintain consistent link styling', 'Consider link context and destination'],
|
|
@@ -2568,7 +2687,8 @@ export var components = [{
|
|
|
2568
2687
|
}, {
|
|
2569
2688
|
name: 'href',
|
|
2570
2689
|
description: 'Standard links can be provided as a string, which should be mapped to the\nunderlying router link component.\n\nAlternatively, you can provide an object for advanced link configurations\nby supplying the expected object type to the generic.\n\n@example\n```\nconst MyRouterLink = forwardRef(\n(\n {\n href,\n children,\n ...rest\n }: RouterLinkComponentProps<{\n href: string;\n replace: boolean;\n }>,\n ref: Ref<HTMLAnchorElement>,\n) => { ...\n```',
|
|
2571
|
-
type: 'string | RouterLinkConfig'
|
|
2690
|
+
type: 'string | RouterLinkConfig',
|
|
2691
|
+
isRequired: true
|
|
2572
2692
|
}, {
|
|
2573
2693
|
name: 'newWindowLabel',
|
|
2574
2694
|
description: 'Override the default text to signify that a link opens in a new window.\nThis is appended to the `aria-label` attribute when the `target` prop is set to `_blank`.',
|
|
@@ -2589,7 +2709,7 @@ export var components = [{
|
|
|
2589
2709
|
category: 'primitive',
|
|
2590
2710
|
description: 'A primitive Bleed component for extending content beyond container boundaries with compiled styling support.',
|
|
2591
2711
|
status: 'general-availability',
|
|
2592
|
-
examples: ['import { Bleed, Box } from \'@atlaskit/primitives/compiled\';\
|
|
2712
|
+
examples: ['import { Bleed, Box } from \'@atlaskit/primitives/compiled\';\nconst _default_1: React.JSX.Element[] = [\n\t<Box padding="space.200" backgroundColor="color.background.neutral.subtle">\n\t\t<Bleed inline="space.100">\n\t\t\t<Box backgroundColor="color.background.brand.bold" padding="space.100">\n\t\t\t\tBleed content\n\t\t\t</Box>\n\t\t</Bleed>\n\t</Box>,\n];\nexport default _default_1;'],
|
|
2593
2713
|
usageGuidelines: ['Use for extending content beyond container margins', 'Leverage compiled styling for performance', 'Use appropriate bleed directions and amounts', 'Consider responsive behavior and container constraints'],
|
|
2594
2714
|
contentGuidelines: ['Use for appropriate layout bleeding', 'Maintain consistent bleeding patterns', 'Consider content hierarchy and visual flow'],
|
|
2595
2715
|
props: [{
|
|
@@ -2603,7 +2723,8 @@ export var components = [{
|
|
|
2603
2723
|
}, {
|
|
2604
2724
|
name: 'children',
|
|
2605
2725
|
description: 'Elements to be rendered inside the Flex.',
|
|
2606
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
2726
|
+
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal',
|
|
2727
|
+
isRequired: true
|
|
2607
2728
|
}, {
|
|
2608
2729
|
name: 'inline',
|
|
2609
2730
|
description: 'Bleed along the inline axis.',
|
|
@@ -2624,13 +2745,14 @@ export var components = [{
|
|
|
2624
2745
|
category: 'primitive',
|
|
2625
2746
|
description: 'A primitive Box component for layout and container purposes with compiled styling support.',
|
|
2626
2747
|
status: 'general-availability',
|
|
2627
|
-
examples: ["/**\n * @jsxRuntime classic\n * @jsx jsx\n */\nimport { cssMap, jsx } from '@atlaskit/css';\nimport { Box } from '@atlaskit/primitives/compiled';\nimport { token } from '@atlaskit/tokens';\nconst styles = cssMap({\n\tbox: {\n\t\tpaddingTop: token('space.200'),\n\t\tpaddingRight: token('space.200'),\n\t\tpaddingBottom: token('space.200'),\n\t\tpaddingLeft: token('space.200'),\n\t\tbackgroundColor: token('color.background.neutral.subtle'),\n\t},\n});\
|
|
2748
|
+
examples: ["/**\n * @jsxRuntime classic\n * @jsx jsx\n */\nimport { cssMap, jsx } from '@atlaskit/css';\nimport { Box } from '@atlaskit/primitives/compiled';\nimport { token } from '@atlaskit/tokens';\nconst styles = cssMap({\n\tbox: {\n\t\tpaddingTop: token('space.200'),\n\t\tpaddingRight: token('space.200'),\n\t\tpaddingBottom: token('space.200'),\n\t\tpaddingLeft: token('space.200'),\n\t\tbackgroundColor: token('color.background.neutral.subtle'),\n\t},\n});\nconst _default_1: JSX.Element[] = [\n\t<Box padding=\"space.200\" backgroundColor=\"color.background.neutral.subtle\">\n\t\tBasic box\n\t</Box>,\n\t<Box xcss={styles.box}>Styled box</Box>,\n];\nexport default _default_1;"],
|
|
2628
2749
|
usageGuidelines: ['Use for basic layout and container needs', 'Leverage compiled styling for performance', 'Use appropriate spacing and layout props', 'Consider semantic HTML when possible'],
|
|
2629
2750
|
contentGuidelines: ['Use for appropriate layout purposes', 'Maintain consistent spacing and layout patterns', 'Consider accessibility and semantic structure'],
|
|
2630
2751
|
props: [{
|
|
2631
2752
|
name: 'as',
|
|
2632
2753
|
description: "The DOM element to render as the Box.\n- This cannot be any SVG-related element such as `'svg'`, `'animate', `'circle'`, and many more\n- This cannot be a `'a'` (use the `Anchor` primitive instead)\n- This cannot be a `'button'` (use the `Anchor` primitive instead)",
|
|
2633
|
-
type: '"object" | "style" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "big" | "blockquote" | "body" | "br" | "canvas" | "caption" | "center" | ...
|
|
2754
|
+
type: '"object" | "style" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "big" | "blockquote" | "body" | "br" | "canvas" | "caption" | "center" | ... 98 more ... | "set"',
|
|
2755
|
+
defaultValue: "'div'"
|
|
2634
2756
|
}, {
|
|
2635
2757
|
name: 'backgroundColor',
|
|
2636
2758
|
description: 'Token representing background color with a built-in fallback value.',
|
|
@@ -2638,7 +2760,7 @@ export var components = [{
|
|
|
2638
2760
|
}, {
|
|
2639
2761
|
name: 'xcss',
|
|
2640
2762
|
description: "Apply a subset of permitted styles powered by Atlassian Design System design tokens.\nIt's preferred you do not use `background` in `xcss` or `cssMap()` and instead use `props.backgroundColor` for surface awareness.",
|
|
2641
|
-
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "height" | "width" | "translate" | "content" | "color" | "border" | "
|
|
2763
|
+
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "height" | "width" | "translate" | "content" | "color" | "border" | "alignmentBaseline" | "baselineShift" | "clip" | ... 487 more ... | "viewTimeline", DesignTokenStyles, ""> & ... 4 more ... & { ...; })'
|
|
2642
2764
|
}]
|
|
2643
2765
|
}, {
|
|
2644
2766
|
name: 'Flex',
|
|
@@ -2647,7 +2769,7 @@ export var components = [{
|
|
|
2647
2769
|
category: 'primitive',
|
|
2648
2770
|
description: 'A primitive Flex component for flexbox layout with compiled styling support.',
|
|
2649
2771
|
status: 'general-availability',
|
|
2650
|
-
examples: ['import { Box, Flex } from \'@atlaskit/primitives/compiled\';\
|
|
2772
|
+
examples: ['import { Box, Flex } from \'@atlaskit/primitives/compiled\';\nconst _default_1: React.JSX.Element[] = [\n\t<Flex gap="space.100" alignItems="center">\n\t\t<Box backgroundColor="color.background.accent.blue.subtle" padding="space.100">\n\t\t\tItem 1\n\t\t</Box>\n\t\t<Box backgroundColor="color.background.accent.green.subtle" padding="space.100">\n\t\t\tItem 2\n\t\t</Box>\n\t</Flex>,\n];\nexport default _default_1;'],
|
|
2651
2773
|
usageGuidelines: ['Use for flexbox layout needs', 'Leverage compiled styling for performance', 'Use appropriate flex properties and alignment', 'Consider responsive behavior'],
|
|
2652
2774
|
contentGuidelines: ['Use for appropriate flex layout', 'Maintain consistent flex patterns', 'Consider content alignment and distribution'],
|
|
2653
2775
|
props: [{
|
|
@@ -2661,7 +2783,8 @@ export var components = [{
|
|
|
2661
2783
|
}, {
|
|
2662
2784
|
name: 'children',
|
|
2663
2785
|
description: 'Elements to be rendered inside the Flex.',
|
|
2664
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
2786
|
+
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal',
|
|
2787
|
+
isRequired: true
|
|
2665
2788
|
}, {
|
|
2666
2789
|
name: 'columnGap',
|
|
2667
2790
|
description: 'Represents the space between each child.',
|
|
@@ -2693,7 +2816,7 @@ export var components = [{
|
|
|
2693
2816
|
}, {
|
|
2694
2817
|
name: 'xcss',
|
|
2695
2818
|
description: 'Apply a subset of permitted styles powered by Atlassian Design System design tokens.',
|
|
2696
|
-
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "
|
|
2819
|
+
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "justifyContent" | "alignItems" | "columnGap" | "gap" | "rowGap" | "direction" | "flex" | "grid" | "fill" | "stroke" | ... 487 more ... | "glyphOrientationVertical", DesignTokenStyles, ""> & ... 4 more ... & { ...; })'
|
|
2697
2820
|
}]
|
|
2698
2821
|
}, {
|
|
2699
2822
|
name: 'Focusable',
|
|
@@ -2702,14 +2825,15 @@ export var components = [{
|
|
|
2702
2825
|
category: 'primitive',
|
|
2703
2826
|
description: 'A primitive Focusable component for keyboard navigation and focus management with compiled styling support.',
|
|
2704
2827
|
status: 'general-availability',
|
|
2705
|
-
examples: ['import { Box, Focusable } from \'@atlaskit/primitives/compiled\';\
|
|
2828
|
+
examples: ['import { Box, Focusable } from \'@atlaskit/primitives/compiled\';\nconst _default_1: React.JSX.Element[] = [\n\t<Focusable>\n\t\t<Box padding="space.200" backgroundColor="color.background.neutral.subtle">\n\t\t\tFocusable content\n\t\t</Box>\n\t</Focusable>,\n];\nexport default _default_1;'],
|
|
2706
2829
|
accessibilityGuidelines: ['Provide clear focus indicators', 'Use appropriate tab order and navigation', 'Ensure keyboard accessibility', 'Provide clear visual feedback for focus state', 'Use appropriate ARIA attributes'],
|
|
2707
2830
|
usageGuidelines: ['Use for elements that need keyboard focus', 'Leverage compiled styling for performance', 'Use appropriate focus management', 'Consider keyboard navigation patterns'],
|
|
2708
2831
|
contentGuidelines: ['Use for appropriate focusable content', 'Maintain consistent focus patterns', 'Consider keyboard navigation flow'],
|
|
2709
2832
|
props: [{
|
|
2710
2833
|
name: 'as',
|
|
2711
2834
|
description: 'The DOM element to render as the Focusable element.',
|
|
2712
|
-
type: '"symbol" | "object" | "style" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "big" | "blockquote" | "body" | "br" | "canvas" | "caption" | ...
|
|
2835
|
+
type: '"symbol" | "object" | "style" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "big" | "blockquote" | "body" | "br" | "canvas" | "caption" | ... 156 more ... | "view"',
|
|
2836
|
+
defaultValue: "'button'"
|
|
2713
2837
|
}, {
|
|
2714
2838
|
name: 'children',
|
|
2715
2839
|
description: '',
|
|
@@ -2730,7 +2854,7 @@ export var components = [{
|
|
|
2730
2854
|
category: 'primitive',
|
|
2731
2855
|
description: 'A primitive Grid component for CSS Grid layout with compiled styling support.',
|
|
2732
2856
|
status: 'general-availability',
|
|
2733
|
-
examples: ['import { cssMap } from \'@atlaskit/css\';\nimport { Box, Grid } from \'@atlaskit/primitives/compiled\';\nconst styles = cssMap({\n\tgrid: {\n\t\tgridTemplateColumns: \'1fr 1fr\',\n\t},\n});\
|
|
2857
|
+
examples: ['import { cssMap } from \'@atlaskit/css\';\nimport { Box, Grid } from \'@atlaskit/primitives/compiled\';\nconst styles = cssMap({\n\tgrid: {\n\t\tgridTemplateColumns: \'1fr 1fr\',\n\t},\n});\nconst _default_1: React.JSX.Element[] = [\n\t<Grid gap="space.200" xcss={styles.grid}>\n\t\t<Box backgroundColor="color.background.accent.blue.subtle" padding="space.200">\n\t\t\tGrid item 1\n\t\t</Box>\n\t\t<Box backgroundColor="color.background.accent.green.subtle" padding="space.200">\n\t\t\tGrid item 2\n\t\t</Box>\n\t</Grid>,\n];\nexport default _default_1;'],
|
|
2734
2858
|
usageGuidelines: ['Use for CSS Grid layout needs', 'Leverage compiled styling for performance', 'Use appropriate grid properties and alignment', 'Consider responsive behavior'],
|
|
2735
2859
|
contentGuidelines: ['Use for appropriate grid layout', 'Maintain consistent grid patterns', 'Consider content alignment and distribution'],
|
|
2736
2860
|
props: [{
|
|
@@ -2752,7 +2876,8 @@ export var components = [{
|
|
|
2752
2876
|
}, {
|
|
2753
2877
|
name: 'children',
|
|
2754
2878
|
description: 'Elements to be rendered inside the grid. Required as a grid without children should not be a grid.',
|
|
2755
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
2879
|
+
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal',
|
|
2880
|
+
isRequired: true
|
|
2756
2881
|
}, {
|
|
2757
2882
|
name: 'columnGap',
|
|
2758
2883
|
description: 'Represents the space between each column.',
|
|
@@ -2780,7 +2905,7 @@ export var components = [{
|
|
|
2780
2905
|
}, {
|
|
2781
2906
|
name: 'xcss',
|
|
2782
2907
|
description: 'Apply a subset of permitted styles powered by Atlassian Design System design tokens.',
|
|
2783
|
-
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "
|
|
2908
|
+
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "justifyContent" | "justifyItems" | "alignItems" | "alignContent" | "columnGap" | "gap" | "rowGap" | "flex" | "grid" | ... 488 more ... | "glyphOrientationVertical", DesignTokenStyles, ""> & ... 4 more ... & { ...; })'
|
|
2784
2909
|
}]
|
|
2785
2910
|
}, {
|
|
2786
2911
|
name: 'Inline',
|
|
@@ -2789,7 +2914,7 @@ export var components = [{
|
|
|
2789
2914
|
category: 'primitive',
|
|
2790
2915
|
description: 'A primitive Inline component for horizontal layout with consistent spacing.',
|
|
2791
2916
|
status: 'general-availability',
|
|
2792
|
-
examples: ['import AddIcon from \'@atlaskit/icon/core/add\';\nimport { Inline, Text } from \'@atlaskit/primitives/compiled\';\
|
|
2917
|
+
examples: ['import AddIcon from \'@atlaskit/icon/core/add\';\nimport { Inline, Text } from \'@atlaskit/primitives/compiled\';\nconst _default_1: React.JSX.Element[] = [\n\t<Inline space="space.100">\n\t\t<AddIcon label="Add item" />\n\t\t<Text>Add item</Text>\n\t</Inline>,\n];\nexport default _default_1;'],
|
|
2793
2918
|
usageGuidelines: ['Use for horizontal layout needs', 'Leverage compiled styling for performance', 'Use appropriate spacing and alignment props', 'Consider wrapping behavior'],
|
|
2794
2919
|
contentGuidelines: ['Use for appropriate horizontal grouping', 'Maintain consistent spacing patterns', 'Consider content flow and readability'],
|
|
2795
2920
|
props: [{
|
|
@@ -2807,7 +2932,8 @@ export var components = [{
|
|
|
2807
2932
|
}, {
|
|
2808
2933
|
name: 'children',
|
|
2809
2934
|
description: 'Elements to be rendered inside the Inline.',
|
|
2810
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
2935
|
+
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal',
|
|
2936
|
+
isRequired: true
|
|
2811
2937
|
}, {
|
|
2812
2938
|
name: 'grow',
|
|
2813
2939
|
description: 'Used to set whether the container should grow to fill the available space.',
|
|
@@ -2848,7 +2974,7 @@ export var components = [{
|
|
|
2848
2974
|
category: 'primitive',
|
|
2849
2975
|
description: 'A primitive Text component for typography with compiled styling support.',
|
|
2850
2976
|
status: 'general-availability',
|
|
2851
|
-
examples: ['import { MetricText } from \'@atlaskit/primitives/compiled\';\
|
|
2977
|
+
examples: ['import { MetricText } from \'@atlaskit/primitives/compiled\';\nconst _default_1: React.JSX.Element[] = [\n\t<MetricText size="small">42</MetricText>,\n\t<MetricText size="large">1,234</MetricText>,\n];\nexport default _default_1;'],
|
|
2852
2978
|
usageGuidelines: ['Use for text content with consistent typography', 'Leverage compiled styling for performance', 'Use appropriate font size and weight props', 'Consider semantic HTML elements'],
|
|
2853
2979
|
contentGuidelines: ['Use for appropriate text content', 'Maintain consistent typography patterns', 'Consider readability and hierarchy'],
|
|
2854
2980
|
props: [{
|
|
@@ -2862,7 +2988,8 @@ export var components = [{
|
|
|
2862
2988
|
}, {
|
|
2863
2989
|
name: 'children',
|
|
2864
2990
|
description: 'Elements rendered within the Text element.',
|
|
2865
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
2991
|
+
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal',
|
|
2992
|
+
isRequired: true
|
|
2866
2993
|
}, {
|
|
2867
2994
|
name: 'id',
|
|
2868
2995
|
description: 'The [HTML `id` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id).',
|
|
@@ -2874,7 +3001,8 @@ export var components = [{
|
|
|
2874
3001
|
}, {
|
|
2875
3002
|
name: 'size',
|
|
2876
3003
|
description: 'Text size.',
|
|
2877
|
-
type: '"small" | "medium" | "large"'
|
|
3004
|
+
type: '"small" | "medium" | "large"',
|
|
3005
|
+
isRequired: true
|
|
2878
3006
|
}]
|
|
2879
3007
|
}, {
|
|
2880
3008
|
name: 'Pressable',
|
|
@@ -2883,7 +3011,7 @@ export var components = [{
|
|
|
2883
3011
|
category: 'primitive',
|
|
2884
3012
|
description: 'A primitive Pressable component for handling touch and click interactions with compiled styling support.',
|
|
2885
3013
|
status: 'general-availability',
|
|
2886
|
-
examples: ["import { Pressable } from '@atlaskit/primitives/compiled';\
|
|
3014
|
+
examples: ["import { Pressable } from '@atlaskit/primitives/compiled';\nconst _default_1: React.JSX.Element[] = [\n\t<Pressable onClick={() => alert('Pressed!')}>Custom button</Pressable>,\n];\nexport default _default_1;"],
|
|
2887
3015
|
accessibilityGuidelines: ['Provide clear visual feedback for press states', 'Ensure appropriate touch target sizes', 'Use appropriate ARIA attributes for interactive elements', 'Provide keyboard navigation support'],
|
|
2888
3016
|
usageGuidelines: ['Use for interactive elements that need press feedback', 'Leverage compiled styling for performance', 'Use appropriate press states and feedback', 'Consider touch target accessibility'],
|
|
2889
3017
|
contentGuidelines: ['Use for appropriate interactive content', 'Maintain consistent press patterns', 'Consider user interaction expectations'],
|
|
@@ -2907,7 +3035,7 @@ export var components = [{
|
|
|
2907
3035
|
category: 'primitive',
|
|
2908
3036
|
description: 'A primitive Stack component for vertical and horizontal layout with consistent spacing.',
|
|
2909
3037
|
status: 'general-availability',
|
|
2910
|
-
examples: ['import Heading from \'@atlaskit/heading\';\nimport { Stack, Text } from \'@atlaskit/primitives/compiled\';\
|
|
3038
|
+
examples: ['import Heading from \'@atlaskit/heading\';\nimport { Stack, Text } from \'@atlaskit/primitives/compiled\';\nconst _default_1: React.JSX.Element[] = [\n\t<Stack space="space.100">\n\t\t<Heading size="medium">User name</Heading>\n\t\t<Text>Description</Text>\n\t</Stack>,\n];\nexport default _default_1;'],
|
|
2911
3039
|
usageGuidelines: ['Use for consistent vertical or horizontal layouts', 'Leverage compiled styling for performance', 'Use appropriate spacing and alignment props', 'Consider responsive behavior'],
|
|
2912
3040
|
contentGuidelines: ['Use for appropriate layout grouping', 'Maintain consistent spacing patterns', 'Consider content hierarchy and flow'],
|
|
2913
3041
|
props: [{
|
|
@@ -2925,7 +3053,8 @@ export var components = [{
|
|
|
2925
3053
|
}, {
|
|
2926
3054
|
name: 'children',
|
|
2927
3055
|
description: 'Elements to be rendered inside the Stack.',
|
|
2928
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
3056
|
+
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal',
|
|
3057
|
+
isRequired: true
|
|
2929
3058
|
}, {
|
|
2930
3059
|
name: 'grow',
|
|
2931
3060
|
description: 'Used to set whether the container should grow to fill the available space.',
|
|
@@ -2954,7 +3083,7 @@ export var components = [{
|
|
|
2954
3083
|
category: 'primitive',
|
|
2955
3084
|
description: 'A primitive Text component for typography with compiled styling support.',
|
|
2956
3085
|
status: 'general-availability',
|
|
2957
|
-
examples: ['import { Text } from \'@atlaskit/primitives/compiled\';\
|
|
3086
|
+
examples: ['import { Text } from \'@atlaskit/primitives/compiled\';\nconst _default_1: React.JSX.Element[] = [\n\t<Text>Default text</Text>,\n\t<Text size="large" weight="bold">\n\t\tLarge bold text\n\t</Text>,\n];\nexport default _default_1;'],
|
|
2958
3087
|
usageGuidelines: ['Use for text content with consistent typography', 'Leverage compiled styling for performance', 'Use appropriate font size and weight props', 'Consider semantic HTML elements'],
|
|
2959
3088
|
contentGuidelines: ['Use for appropriate text content', 'Maintain consistent typography patterns', 'Consider readability and hierarchy'],
|
|
2960
3089
|
props: [{
|
|
@@ -2968,7 +3097,8 @@ export var components = [{
|
|
|
2968
3097
|
}, {
|
|
2969
3098
|
name: 'children',
|
|
2970
3099
|
description: 'Elements rendered within the Text element.',
|
|
2971
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
3100
|
+
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal',
|
|
3101
|
+
isRequired: true
|
|
2972
3102
|
}, {
|
|
2973
3103
|
name: 'color',
|
|
2974
3104
|
description: 'Token representing text color with a built-in fallback value.\nWill apply inverse text color automatically if placed within a Box with bold background color.\nDefaults to `color.text` if not nested in other Text components.',
|
|
@@ -3012,7 +3142,8 @@ export var components = [{
|
|
|
3012
3142
|
props: [{
|
|
3013
3143
|
name: 'appearance',
|
|
3014
3144
|
description: 'The visual style of the progress bar.',
|
|
3015
|
-
type: '"default" | "success" | "inverse"'
|
|
3145
|
+
type: '"default" | "success" | "inverse"',
|
|
3146
|
+
defaultValue: '"default"'
|
|
3016
3147
|
}, {
|
|
3017
3148
|
name: 'ariaLabel',
|
|
3018
3149
|
description: "This is the descriptive label that's associated with the progress bar.\nAlways include useful information on the current state of the progress bar so that people who use assistive technology can understand what the current state of the progress bar is.",
|
|
@@ -3020,11 +3151,13 @@ export var components = [{
|
|
|
3020
3151
|
}, {
|
|
3021
3152
|
name: 'isIndeterminate',
|
|
3022
3153
|
description: 'Shows the progress bar in an indeterminate state when `true`.',
|
|
3023
|
-
type: 'boolean'
|
|
3154
|
+
type: 'boolean',
|
|
3155
|
+
defaultValue: 'false'
|
|
3024
3156
|
}, {
|
|
3025
3157
|
name: 'value',
|
|
3026
3158
|
description: 'Sets the value of the progress bar, between `0` and `1` inclusive.',
|
|
3027
|
-
type: 'number'
|
|
3159
|
+
type: 'number',
|
|
3160
|
+
defaultValue: '0'
|
|
3028
3161
|
}]
|
|
3029
3162
|
}, {
|
|
3030
3163
|
name: 'SuccessProgressBar',
|
|
@@ -3043,11 +3176,13 @@ export var components = [{
|
|
|
3043
3176
|
}, {
|
|
3044
3177
|
name: 'isIndeterminate',
|
|
3045
3178
|
description: 'Shows the progress bar in an indeterminate state when `true`.',
|
|
3046
|
-
type: 'boolean'
|
|
3179
|
+
type: 'boolean',
|
|
3180
|
+
defaultValue: 'false'
|
|
3047
3181
|
}, {
|
|
3048
3182
|
name: 'value',
|
|
3049
3183
|
description: 'Sets the value of the progress bar, between `0` and `1` inclusive.',
|
|
3050
|
-
type: 'number'
|
|
3184
|
+
type: 'number',
|
|
3185
|
+
defaultValue: '0'
|
|
3051
3186
|
}]
|
|
3052
3187
|
}, {
|
|
3053
3188
|
name: 'TransparentProgressBar',
|
|
@@ -3066,11 +3201,13 @@ export var components = [{
|
|
|
3066
3201
|
}, {
|
|
3067
3202
|
name: 'isIndeterminate',
|
|
3068
3203
|
description: 'Shows the progress bar in an indeterminate state when `true`.',
|
|
3069
|
-
type: 'boolean'
|
|
3204
|
+
type: 'boolean',
|
|
3205
|
+
defaultValue: 'false'
|
|
3070
3206
|
}, {
|
|
3071
3207
|
name: 'value',
|
|
3072
3208
|
description: 'Sets the value of the progress bar, between `0` and `1` inclusive.',
|
|
3073
|
-
type: 'number'
|
|
3209
|
+
type: 'number',
|
|
3210
|
+
defaultValue: '0'
|
|
3074
3211
|
}]
|
|
3075
3212
|
}, {
|
|
3076
3213
|
name: 'ProgressIndicator',
|
|
@@ -3086,27 +3223,32 @@ export var components = [{
|
|
|
3086
3223
|
props: [{
|
|
3087
3224
|
name: 'appearance',
|
|
3088
3225
|
description: 'Sets the color of the indicators.',
|
|
3089
|
-
type: '"default" | "help" | "inverted" | "primary"'
|
|
3226
|
+
type: '"default" | "help" | "inverted" | "primary"',
|
|
3227
|
+
defaultValue: '"default"'
|
|
3090
3228
|
}, {
|
|
3091
3229
|
name: 'ariaControls',
|
|
3092
3230
|
description: 'If interaction is enabled, use `ariaControls` to tell assistive technology what elements are controlled by the progress indicator.',
|
|
3093
|
-
type: 'string'
|
|
3231
|
+
type: 'string',
|
|
3232
|
+
defaultValue: '"panel"'
|
|
3094
3233
|
}, {
|
|
3095
3234
|
name: 'ariaLabel',
|
|
3096
3235
|
description: 'Describes what the indicator represents to assistive technology. The selected index number will be appended to the label.',
|
|
3097
|
-
type: 'string'
|
|
3236
|
+
type: 'string',
|
|
3237
|
+
defaultValue: '"tab"'
|
|
3098
3238
|
}, {
|
|
3099
3239
|
name: 'onSelect',
|
|
3100
3240
|
description: 'Function called when an indicator is selected.',
|
|
3101
|
-
type: '(eventData: { event: MouseEvent<HTMLButtonElement,
|
|
3241
|
+
type: '(eventData: { event: React.MouseEvent<HTMLButtonElement, MouseEvent>; index: number; }, analyticsEvent: UIAnalyticsEvent) => void'
|
|
3102
3242
|
}, {
|
|
3103
3243
|
name: 'selectedIndex',
|
|
3104
3244
|
description: 'Which indicator is currently selected.',
|
|
3105
|
-
type: 'number'
|
|
3245
|
+
type: 'number',
|
|
3246
|
+
isRequired: true
|
|
3106
3247
|
}, {
|
|
3107
3248
|
name: 'size',
|
|
3108
3249
|
description: 'Sets the width and height of each indicator.',
|
|
3109
|
-
type: '"default" | "large"'
|
|
3250
|
+
type: '"default" | "large"',
|
|
3251
|
+
defaultValue: '"default"'
|
|
3110
3252
|
}, {
|
|
3111
3253
|
name: 'spacing',
|
|
3112
3254
|
description: 'Specifies how much of a gutter there is between indicators.',
|
|
@@ -3114,7 +3256,8 @@ export var components = [{
|
|
|
3114
3256
|
}, {
|
|
3115
3257
|
name: 'values',
|
|
3116
3258
|
description: 'An array of values mapped over to create the indicators.',
|
|
3117
|
-
type: 'any[]'
|
|
3259
|
+
type: 'any[]',
|
|
3260
|
+
isRequired: true
|
|
3118
3261
|
}]
|
|
3119
3262
|
}, {
|
|
3120
3263
|
name: 'ProgressTracker',
|
|
@@ -3130,19 +3273,24 @@ export var components = [{
|
|
|
3130
3273
|
props: [{
|
|
3131
3274
|
name: 'animated',
|
|
3132
3275
|
description: 'Turns off transition animations if set to false.',
|
|
3133
|
-
type: 'boolean'
|
|
3276
|
+
type: 'boolean',
|
|
3277
|
+
defaultValue: 'true'
|
|
3134
3278
|
}, {
|
|
3135
3279
|
name: 'items',
|
|
3136
3280
|
description: 'Ordered list of stage data.',
|
|
3137
|
-
type: 'Stage[]'
|
|
3281
|
+
type: 'Stage[]',
|
|
3282
|
+
isRequired: true,
|
|
3283
|
+
defaultValue: '[]'
|
|
3138
3284
|
}, {
|
|
3139
3285
|
name: 'label',
|
|
3140
3286
|
description: 'Use this to provide an aria-label for the overall progress tracker, so that people who use assistive technology get an overview of the tracker\'s purpose. For example, "Sign up progress".',
|
|
3141
|
-
type: 'string'
|
|
3287
|
+
type: 'string',
|
|
3288
|
+
defaultValue: '"Progress"'
|
|
3142
3289
|
}, {
|
|
3143
3290
|
name: 'spacing',
|
|
3144
3291
|
description: 'Sets the amount of spacing between the steps.',
|
|
3145
|
-
type: '"
|
|
3292
|
+
type: '"cozy" | "comfortable" | "compact"',
|
|
3293
|
+
defaultValue: '"cozy"'
|
|
3146
3294
|
}]
|
|
3147
3295
|
}, {
|
|
3148
3296
|
name: 'Radio',
|
|
@@ -3242,7 +3390,8 @@ export var components = [{
|
|
|
3242
3390
|
}, {
|
|
3243
3391
|
name: 'options',
|
|
3244
3392
|
description: 'An array of objects, each object is mapped onto a `Radio` element within the group. Name must be unique to the group.',
|
|
3245
|
-
type: 'OptionPropType[]'
|
|
3393
|
+
type: 'OptionPropType[]',
|
|
3394
|
+
isRequired: true
|
|
3246
3395
|
}, {
|
|
3247
3396
|
name: 'value',
|
|
3248
3397
|
description: 'Once set, controls the selected value on the `RadioGroup`.',
|
|
@@ -3310,11 +3459,12 @@ export var components = [{
|
|
|
3310
3459
|
}, {
|
|
3311
3460
|
name: 'children',
|
|
3312
3461
|
description: 'The main content of the section message. This accepts a react node, although\nwe recommend that this should be a paragraph.',
|
|
3313
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
3462
|
+
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal',
|
|
3463
|
+
isRequired: true
|
|
3314
3464
|
}, {
|
|
3315
3465
|
name: 'icon',
|
|
3316
3466
|
description: 'An Icon component to be rendered instead of the default icon for the component.\nThis should only be an `@atlaskit/icon` icon. You can check out [this example](/packages/design-system/section-message/example/custom-icon)\nto see how to provide this icon.',
|
|
3317
|
-
type: '"symbol" | "object" | "title" | "a" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "big" | "blockquote" | "body" | "br" | "button" | ...
|
|
3467
|
+
type: '"symbol" | "object" | "title" | "a" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "big" | "blockquote" | "body" | "br" | "button" | ... 159 more ... | ComponentType<...>'
|
|
3318
3468
|
}, {
|
|
3319
3469
|
name: 'isDismissible',
|
|
3320
3470
|
description: 'Displays a dismiss button, that allows the user to dismiss the message.\nIt will be removed from the DOM immediately and will not be re-rendered.\nIt does not handle persistence of the dismissed state across page reloads or remounts.',
|
|
@@ -3635,14 +3785,15 @@ export var components = [{
|
|
|
3635
3785
|
category: 'loading',
|
|
3636
3786
|
description: 'A skeleton acts as a placeholder for content, usually while the content loads.',
|
|
3637
3787
|
status: 'early-access',
|
|
3638
|
-
examples: ['import Skeleton from \'@atlaskit/skeleton\';\
|
|
3788
|
+
examples: ['import Skeleton from \'@atlaskit/skeleton\';\nconst _default_1: React.JSX.Element[] = [<Skeleton width="200px" height="100px" isShimmering />];\nexport default _default_1;'],
|
|
3639
3789
|
accessibilityGuidelines: ['Provide appropriate loading announcements', 'Use skeleton patterns that match actual content structure', 'Ensure skeleton content is not announced as actual content', 'Consider screen reader experience during loading states'],
|
|
3640
3790
|
usageGuidelines: ['Use to indicate content is loading', 'Match skeleton structure to actual content layout', 'Use appropriate animation and timing', 'Replace with actual content when ready', 'Consider different skeleton patterns for different content types'],
|
|
3641
3791
|
contentGuidelines: ['Use skeleton patterns that represent actual content structure', 'Maintain consistent skeleton styling', 'Consider content hierarchy in skeleton design', 'Use appropriate animation timing'],
|
|
3642
3792
|
props: [{
|
|
3643
3793
|
name: 'borderRadius',
|
|
3644
3794
|
description: "Controls the border radius, or rounding of the skeleton's corners.",
|
|
3645
|
-
type: 'string | number'
|
|
3795
|
+
type: 'string | number',
|
|
3796
|
+
defaultValue: '"var(--ds-radius-small)"'
|
|
3646
3797
|
}, {
|
|
3647
3798
|
name: 'color',
|
|
3648
3799
|
description: 'Overrides the default color of skeleton, and overrides the default shimmering start color if ShimmeringEndColor also provided.',
|
|
@@ -3654,11 +3805,13 @@ export var components = [{
|
|
|
3654
3805
|
}, {
|
|
3655
3806
|
name: 'height',
|
|
3656
3807
|
description: '',
|
|
3657
|
-
type: 'string | number'
|
|
3808
|
+
type: 'string | number',
|
|
3809
|
+
isRequired: true
|
|
3658
3810
|
}, {
|
|
3659
3811
|
name: 'isShimmering',
|
|
3660
3812
|
description: 'Enables the shimmering animation.',
|
|
3661
|
-
type: 'boolean'
|
|
3813
|
+
type: 'boolean',
|
|
3814
|
+
defaultValue: 'false'
|
|
3662
3815
|
}, {
|
|
3663
3816
|
name: 'ShimmeringEndColor',
|
|
3664
3817
|
description: 'Overrides the default shimmering ending color of skeleton.',
|
|
@@ -3666,7 +3819,8 @@ export var components = [{
|
|
|
3666
3819
|
}, {
|
|
3667
3820
|
name: 'width',
|
|
3668
3821
|
description: '',
|
|
3669
|
-
type: 'string | number'
|
|
3822
|
+
type: 'string | number',
|
|
3823
|
+
isRequired: true
|
|
3670
3824
|
}]
|
|
3671
3825
|
}, {
|
|
3672
3826
|
name: 'Spinner',
|
|
@@ -3675,7 +3829,7 @@ export var components = [{
|
|
|
3675
3829
|
category: 'feedback',
|
|
3676
3830
|
description: 'A loading spinner component.',
|
|
3677
3831
|
status: 'general-availability',
|
|
3678
|
-
examples: ['import Spinner from \'@atlaskit/spinner\';\
|
|
3832
|
+
examples: ['import Spinner from \'@atlaskit/spinner\';\nconst _default_1: React.JSX.Element[] = [\n\t<Spinner size="small" />,\n\t<Spinner size="medium" />,\n\t<Spinner size="large" />,\n];\nexport default _default_1;'],
|
|
3679
3833
|
accessibilityGuidelines: ['Provide appropriate loading announcements', 'Use appropriate timing for spinner display', 'Ensure spinner is announced to screen readers', 'Consider alternative loading indicators'],
|
|
3680
3834
|
usageGuidelines: ['Use for loading states of unknown duration', 'Consider delay before showing spinner', 'Use appropriate size for context', 'Provide loading context when possible'],
|
|
3681
3835
|
contentGuidelines: ['Use consistent spinner sizing', 'Consider spinner placement and context', 'Provide loading feedback when appropriate'],
|
|
@@ -3710,7 +3864,8 @@ export var components = [{
|
|
|
3710
3864
|
props: [{
|
|
3711
3865
|
name: 'children',
|
|
3712
3866
|
description: "The children of Tabs. The first child should be a `TabList` filled with `Tab`'s.\nSubsequent children should be `TabPanel`'s. There should be a `Tab` for each `TabPanel`.\nIf you want to customize `Tab` or `TabPanel`, refer to the examples in the documentation.",
|
|
3713
|
-
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.ReactPortal'
|
|
3867
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.ReactPortal',
|
|
3868
|
+
isRequired: true
|
|
3714
3869
|
}, {
|
|
3715
3870
|
name: 'defaultSelected',
|
|
3716
3871
|
description: 'The index of the tab that will be selected by default when the component mounts.\nIf not set the first tab will be displayed by default.',
|
|
@@ -3718,7 +3873,8 @@ export var components = [{
|
|
|
3718
3873
|
}, {
|
|
3719
3874
|
name: 'id',
|
|
3720
3875
|
description: 'A unique ID that will be used to generate IDs for tabs and tab panels.\nThis is required for accessibility purposes.',
|
|
3721
|
-
type: 'string'
|
|
3876
|
+
type: 'string',
|
|
3877
|
+
isRequired: true
|
|
3722
3878
|
}, {
|
|
3723
3879
|
name: 'onChange',
|
|
3724
3880
|
description: 'A callback function which will be fired when a changed. It will be passed\nthe index of the selected tab and a `UIAnalyticsEvent`.',
|
|
@@ -3767,6 +3923,14 @@ export var components = [{
|
|
|
3767
3923
|
name: 'linkComponent',
|
|
3768
3924
|
description: '',
|
|
3769
3925
|
type: 'ComponentClass<any, any> | FunctionComponent<any>'
|
|
3926
|
+
}, {
|
|
3927
|
+
name: 'maxWidth',
|
|
3928
|
+
description: "Maximum width of the tag text. When exceeded, text will be truncated with ellipsis.\nAccepts any valid CSS max-width value (e.g., '200px', '15rem', '100%').",
|
|
3929
|
+
type: 'string | number'
|
|
3930
|
+
}, {
|
|
3931
|
+
name: 'migration_fallback',
|
|
3932
|
+
description: "@internal\n**Temporary / Internal only for migration.**\n\nWhen set to `'lozenge'` and the feature flag `platform-dst-lozenge-tag-badge-visual-uplifts`\nis OFF, renders as a Lozenge component instead of Tag. This enables safe, staged migration\nfrom Lozenge to Tag for large consumers.\n\nThis prop will be removed via codemod after migration is complete.",
|
|
3933
|
+
type: 'string'
|
|
3770
3934
|
}, {
|
|
3771
3935
|
name: 'onAfterRemoveAction',
|
|
3772
3936
|
description: "Handler to be called after tag is removed. Called with the string 'Post\nRemoval Hook'.",
|
|
@@ -3782,7 +3946,8 @@ export var components = [{
|
|
|
3782
3946
|
}, {
|
|
3783
3947
|
name: 'text',
|
|
3784
3948
|
description: 'Text to be displayed in the tag.',
|
|
3785
|
-
type: 'string'
|
|
3949
|
+
type: 'string',
|
|
3950
|
+
isRequired: true
|
|
3786
3951
|
}]
|
|
3787
3952
|
}, {
|
|
3788
3953
|
name: 'TagGroup',
|
|
@@ -3802,7 +3967,8 @@ export var components = [{
|
|
|
3802
3967
|
}, {
|
|
3803
3968
|
name: 'children',
|
|
3804
3969
|
description: 'Tags to render within the tag group.',
|
|
3805
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
3970
|
+
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal',
|
|
3971
|
+
isRequired: true
|
|
3806
3972
|
}, {
|
|
3807
3973
|
name: 'label',
|
|
3808
3974
|
description: 'Refers to an `aria-label` attribute. Sets an accessible name for the tags group wrapper to announce it to users of assistive technology.\nUsage of either this, or the `titleId` attribute is strongly recommended.',
|
|
@@ -4050,7 +4216,8 @@ export var components = [{
|
|
|
4050
4216
|
}, {
|
|
4051
4217
|
name: 'children',
|
|
4052
4218
|
description: 'Elements to be wrapped by the tooltip.\nIt can be either a:\n1. `ReactNode`\n2. Function which returns a `ReactNode`',
|
|
4053
|
-
type: 'React.ReactNode | ((props: TriggerProps) => React.ReactNode)'
|
|
4219
|
+
type: 'React.ReactNode | ((props: TriggerProps) => React.ReactNode)',
|
|
4220
|
+
isRequired: true
|
|
4054
4221
|
}, {
|
|
4055
4222
|
name: 'component',
|
|
4056
4223
|
description: 'Extend `TooltipPrimitive` to create your own tooltip and pass it as component.',
|
|
@@ -4058,43 +4225,53 @@ export var components = [{
|
|
|
4058
4225
|
}, {
|
|
4059
4226
|
name: 'content',
|
|
4060
4227
|
description: 'The content of the tooltip. It can be either a:\n1. `ReactNode`\n2. Function which returns a `ReactNode`\nThe benefit of the second approach is that it allows you to consume the `update` render prop.\nThis `update` function can be called to manually recalculate the position of the tooltip.\n\nThis content will be rendered into two places:\n1. Into the tooltip\n2. Into a hidden element for screen readers (unless `isScreenReaderAnnouncementDisabled` is set to `true`)',
|
|
4061
|
-
type: 'React.ReactNode | (({ update }: { update?: () => void; }) => React.ReactNode)'
|
|
4228
|
+
type: 'React.ReactNode | (({ update }: { update?: () => void; }) => React.ReactNode)',
|
|
4229
|
+
isRequired: true
|
|
4062
4230
|
}, {
|
|
4063
4231
|
name: 'delay',
|
|
4064
4232
|
description: 'Time in milliseconds to wait before showing and hiding the tooltip. Defaults to 300.',
|
|
4065
|
-
type: 'number'
|
|
4233
|
+
type: 'number',
|
|
4234
|
+
defaultValue: '300'
|
|
4066
4235
|
}, {
|
|
4067
4236
|
name: 'hideTooltipOnClick',
|
|
4068
4237
|
description: 'Hide the tooltip when the click event is triggered. Use this when the tooltip should be hidden if `onClick` react synthetic event\nis triggered, which happens after `onMouseDown` event.',
|
|
4069
|
-
type: 'boolean'
|
|
4238
|
+
type: 'boolean',
|
|
4239
|
+
defaultValue: 'false'
|
|
4070
4240
|
}, {
|
|
4071
4241
|
name: 'hideTooltipOnMouseDown',
|
|
4072
4242
|
description: 'Hide the tooltip when the mousedown event is triggered. This should be\nused when tooltip should be hidden if `onMouseDown` react synthetic event\nis triggered, which happens before `onClick` event.',
|
|
4073
|
-
type: 'boolean'
|
|
4243
|
+
type: 'boolean',
|
|
4244
|
+
defaultValue: 'false'
|
|
4074
4245
|
}, {
|
|
4075
4246
|
name: 'ignoreTooltipPointerEvents',
|
|
4076
4247
|
description: 'Adds `pointer-events: none` to the tooltip itself. Setting this to true will also prevent the tooltip from persisting when hovered.',
|
|
4077
|
-
type: 'boolean'
|
|
4248
|
+
type: 'boolean',
|
|
4249
|
+
defaultValue: 'false'
|
|
4078
4250
|
}, {
|
|
4079
4251
|
name: 'isScreenReaderAnnouncementDisabled',
|
|
4080
4252
|
description: 'By default tooltip content will be duplicated into a hidden element so\nit can be read out by a screen reader. Sometimes this is not ideal as\nit can result in the same content be announced twice. For those situations,\nyou can leverage this prop to disable the duplicate hidden text.',
|
|
4081
|
-
type: 'boolean'
|
|
4253
|
+
type: 'boolean',
|
|
4254
|
+
defaultValue: 'false'
|
|
4082
4255
|
}, {
|
|
4083
4256
|
name: 'mousePosition',
|
|
4084
|
-
description: 'Where the tooltip should appear relative to the mouse pointer.\nOnly use this when the `position` prop is set to `"mouse"`.\nWhen interacting with the target element using a keyboard, it will use this position against the target element instead.',
|
|
4085
|
-
type: 'AutoPlacement | BasePlacement | VariationPlacement'
|
|
4257
|
+
description: 'Where the tooltip should appear relative to the mouse pointer.\nOnly use this when the `position` prop is set to `"mouse"`, `"mouse-y"`, or `"mouse-x"`.\nWhen interacting with the target element using a keyboard, it will use this position against the target element instead.',
|
|
4258
|
+
type: 'AutoPlacement | BasePlacement | VariationPlacement',
|
|
4259
|
+
defaultValue: '"bottom"'
|
|
4086
4260
|
}, {
|
|
4087
4261
|
name: 'onHide',
|
|
4088
4262
|
description: "Function to be called when the tooltip will be hidden. It's called after the\ndelay, when the tooltip begins to animate out.",
|
|
4089
|
-
type: '(analyticsEvent: UIAnalyticsEvent) => void'
|
|
4263
|
+
type: '(analyticsEvent: UIAnalyticsEvent) => void',
|
|
4264
|
+
defaultValue: 'noop'
|
|
4090
4265
|
}, {
|
|
4091
4266
|
name: 'onShow',
|
|
4092
4267
|
description: "Function to be called when the tooltip will be shown. It's called when the\ntooltip begins to animate in.",
|
|
4093
|
-
type: '(analyticsEvent: UIAnalyticsEvent) => void'
|
|
4268
|
+
type: '(analyticsEvent: UIAnalyticsEvent) => void',
|
|
4269
|
+
defaultValue: 'noop'
|
|
4094
4270
|
}, {
|
|
4095
4271
|
name: 'position',
|
|
4096
|
-
description: 'Where the tooltip should appear relative to its target.\nIf set to `"mouse"`, the tooltip will display next to the mouse pointer instead.\nMake sure to utilize the `mousePosition` if you want to customize where the tooltip will show in relation to the mouse.',
|
|
4097
|
-
type: 'Placement | "mouse"'
|
|
4272
|
+
description: 'Where the tooltip should appear relative to its target.\nIf set to `"mouse"`, the tooltip will display next to the mouse pointer instead.\nIf set to `"mouse-y"`, the tooltip will use the mouse Y coordinate but the target X coordinate.\nIf set to `"mouse-x"`, the tooltip will use the mouse X coordinate but the target Y coordinate.\nMake sure to utilize the `mousePosition` if you want to customize where the tooltip will show in relation to the mouse.',
|
|
4273
|
+
type: 'Placement | "mouse" | "mouse-y" | "mouse-x"',
|
|
4274
|
+
defaultValue: '"bottom"'
|
|
4098
4275
|
}, {
|
|
4099
4276
|
name: 'shortcut',
|
|
4100
4277
|
description: 'Display a keyboard shortcut in the tooltip.\n\nKeys will be displayed as individual keyboard key segments after the tooltip content.',
|
|
@@ -4102,11 +4279,21 @@ export var components = [{
|
|
|
4102
4279
|
}, {
|
|
4103
4280
|
name: 'strategy',
|
|
4104
4281
|
description: 'Use this to define the strategy of popper.',
|
|
4105
|
-
type: '"fixed" | "absolute"'
|
|
4282
|
+
type: '"fixed" | "absolute"',
|
|
4283
|
+
defaultValue: '"fixed"'
|
|
4106
4284
|
}, {
|
|
4107
4285
|
name: 'tag',
|
|
4108
4286
|
description: 'Replace the wrapping element. This accepts the name of a html tag which will\nbe used to wrap the element.\nIf you provide a component, it needs to support a ref prop which is used by popper for positioning.',
|
|
4109
4287
|
type: 'keyof JSX.IntrinsicElements | React.ComponentType<React.AllHTMLAttributes<HTMLElement> & { ref: React.Ref<HTMLElement>; }> | React.ForwardRefExoticComponent<...>'
|
|
4288
|
+
}, {
|
|
4289
|
+
name: 'UNSAFE_shouldAlwaysFadeIn',
|
|
4290
|
+
description: 'When set to true, the tooltip will always use the fade-in animation\nand never use the show-immediate behavior, even when another tooltip\nis already visible.',
|
|
4291
|
+
type: 'boolean'
|
|
4292
|
+
}, {
|
|
4293
|
+
name: 'UNSAFE_shouldRenderToParent',
|
|
4294
|
+
description: 'When enabled, the tooltip will be rendered as a sibling to the trigger element instead of being portaled to the document body.\n\nThis is an experimental prop and may be removed at any time. It is not yet intended for public use.',
|
|
4295
|
+
type: 'boolean',
|
|
4296
|
+
defaultValue: 'false'
|
|
4110
4297
|
}]
|
|
4111
4298
|
}, {
|
|
4112
4299
|
name: 'VisuallyHidden',
|
|
@@ -4122,7 +4309,8 @@ export var components = [{
|
|
|
4122
4309
|
props: [{
|
|
4123
4310
|
name: 'children',
|
|
4124
4311
|
description: 'The element or elements that should be hidden.',
|
|
4125
|
-
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
4312
|
+
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal',
|
|
4313
|
+
isRequired: true
|
|
4126
4314
|
}, {
|
|
4127
4315
|
name: 'id',
|
|
4128
4316
|
description: 'An id may be appropriate for this component if used in conjunction with `aria-describedby`\non a paired element.',
|