@atlaskit/ads-mcp 0.13.1 → 0.13.2
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 +7 -0
- package/dist/cjs/tools/get-components/components.js +72 -76
- package/dist/es2019/tools/get-components/components.js +72 -76
- package/dist/esm/tools/get-components/components.js +72 -76
- package/dist/types/tools/get-components/components.d.ts +1 -1
- package/dist/types-ts4.5/tools/get-components/components.d.ts +1 -1
- package/package.json +3 -3
|
@@ -9,7 +9,7 @@ exports.components = void 0;
|
|
|
9
9
|
*
|
|
10
10
|
* Generates TypeScript components data for AI tooling from offerings.json files
|
|
11
11
|
*
|
|
12
|
-
* @codegen <<SignedSource::
|
|
12
|
+
* @codegen <<SignedSource::1d781f4539138bf6cabcd8c01b207b06>>
|
|
13
13
|
* @codegenCommand yarn workspace @af/ads-ai-tooling codegen:prototyping
|
|
14
14
|
*/
|
|
15
15
|
|
|
@@ -20,7 +20,7 @@ var components = exports.components = [{
|
|
|
20
20
|
category: 'images',
|
|
21
21
|
description: 'A component for displaying user avatars with support for images, initials, and status indicators. An avatar is a visual representation of a user or entity. It can display user images, initials, presence indicators, and status indicators. Avatars help users quickly identify people and entities in your application. They provide visual context and make interfaces more personal and engaging.',
|
|
22
22
|
status: 'general-availability',
|
|
23
|
-
examples: ['import Avatar from \'@atlaskit/avatar\';\
|
|
23
|
+
examples: ['import Avatar from \'@atlaskit/avatar\';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<Avatar src="https://example.com/avatar.jpg" name="John Doe" />\n\t\t<Avatar name="Jane Smith" appearance="hexagon" size="large" status="locked" />\n\t\t<Avatar\n\t\t\tname="Bob Wilson"\n\t\t\tappearance="square"\n\t\t\tsize="small"\n\t\t\tpresence="online"\n\t\t\tstatus="approved"\n\t\t/>\n\t</>\n);\nexport default Examples;'],
|
|
24
24
|
usageGuidelines: ['Use consistent sizing within the same context', 'Place avatars in logical groupings (e.g., team members)', 'Use presence indicators sparingly for real-time status only', 'Use status indicators for approval/permission states', 'Provide fallback initials when images fail to load', 'Use avatars to represent users, teams, projects, or any other entity that needs visual identification', 'Always provide meaningful names for accessibility', 'Use the `name` prop to include alternative text for screen readers', 'For decorative images, remove the `name` prop or leave it empty so it will be ignored by assistive technologies', "Don't use a tooltip with an avatar when it's non-interactive or disabled. The tooltip won't work for keyboard users and screen readers"],
|
|
25
25
|
contentGuidelines: ['Use full names when possible for better recognition', 'For companies/projects, use descriptive names', "Avoid generic terms like 'User' or 'Admin'", 'Use consistent naming conventions across your app', 'Keep names concise but meaningful'],
|
|
26
26
|
props: [{
|
|
@@ -103,7 +103,7 @@ var components = exports.components = [{
|
|
|
103
103
|
category: 'data-display',
|
|
104
104
|
description: 'A component for displaying multiple avatars in a group with overlap and overflow handling.',
|
|
105
105
|
status: 'general-availability',
|
|
106
|
-
examples: ["import AvatarGroup from '@atlaskit/avatar-group';\
|
|
106
|
+
examples: ["import AvatarGroup from '@atlaskit/avatar-group';\nconst Example = (): React.JSX.Element => (\n\t<AvatarGroup\n\t\tappearance=\"stack\"\n\t\tsize=\"large\"\n\t\tonAvatarClick={console.log}\n\t\tdata={[\n\t\t\t{ key: 'uid1', name: 'Bob Smith' },\n\t\t\t{ key: 'uid2', name: 'Design System Team', appearance: 'square' },\n\t\t\t{ key: 'uid3', name: 'Review Agent', appearance: 'hexagon' },\n\t\t\t{ key: 'uid4', name: 'Carol Davis' },\n\t\t]}\n\t\tmaxCount={3}\n\t/>\n);\nexport default Example;"],
|
|
107
107
|
accessibilityGuidelines: ['Provide clear labels for avatar groups', 'Use appropriate overflow handling', 'Ensure keyboard navigation support', 'Provide clear user identification'],
|
|
108
108
|
usageGuidelines: ['Use for displaying multiple users or team members', 'Consider overflow behavior for large groups', 'Use appropriate sizing for context', 'Provide clear user identification'],
|
|
109
109
|
contentGuidelines: ['Use meaningful names for users', 'Consider group context and purpose', 'Provide clear overflow indicators', 'Use consistent naming patterns'],
|
|
@@ -179,14 +179,14 @@ var components = exports.components = [{
|
|
|
179
179
|
category: 'status-indicators',
|
|
180
180
|
description: 'A badge is a visual indicator for numeric values such as tallies and scores, providing quick visual feedback.',
|
|
181
181
|
status: 'general-availability',
|
|
182
|
-
examples: ['import Badge from \'@atlaskit/badge\';\
|
|
182
|
+
examples: ['import Badge from \'@atlaskit/badge\';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<Badge appearance="primary">5</Badge>\n\t\t<Badge appearance="important" max={99}>\n\t\t\t150\n\t\t</Badge>\n\t</>\n);\nexport default Examples;'],
|
|
183
183
|
accessibilityGuidelines: ['Ensure badge content is announced by screen readers', 'Use appropriate color contrast for text readability', 'Provide meaningful context for numeric values', 'Consider alternative text for non-numeric badges'],
|
|
184
184
|
usageGuidelines: ['Use for displaying counts, scores, or status indicators', 'Keep badge content concise and meaningful', 'Use appropriate appearance variants for different contexts', 'Position badges near relevant content', 'Consider maximum value display limits'],
|
|
185
185
|
contentGuidelines: ['Use clear, concise numeric or text values', 'Ensure values are meaningful to users', 'Consider localization for number formatting', 'Use consistent formatting across similar badges'],
|
|
186
186
|
props: [{
|
|
187
187
|
name: 'appearance',
|
|
188
188
|
description: 'Affects the visual style of the badge.',
|
|
189
|
-
type: '"added" | "default" | "important" | "primary" | "primaryInverted" | "removed"'
|
|
189
|
+
type: '"added" | "default" | "important" | "primary" | "primaryInverted" | "removed" | "warning" | "discovery" | "danger" | "neutral" | "success" | "information" | "inverse"'
|
|
190
190
|
}, {
|
|
191
191
|
name: 'children',
|
|
192
192
|
description: 'The value displayed within the badge. A `ReactNode` can be provided for\ncustom-formatted numbers, however, badge should only be used in cases where you want to represent\na number.\nUse a [lozenge](/packages/design-system/lozenge) for non-numeric information.',
|
|
@@ -203,7 +203,7 @@ var components = exports.components = [{
|
|
|
203
203
|
category: 'messaging',
|
|
204
204
|
description: 'A banner displays a prominent message at the top of the screen to communicate important information to users.',
|
|
205
205
|
status: 'general-availability',
|
|
206
|
-
examples: ['import Banner from \'@atlaskit/banner\';\nimport WarningIcon from \'@atlaskit/icon/core/status-warning\';\nimport Box from \'@atlaskit/primitives/box\';\nexport default () => (\n\t<Box>\n\t\t<Banner\n\t\t\ticon={<WarningIcon label="Warning"
|
|
206
|
+
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\n\t\t\ticon={<WarningIcon label="Warning" spacing="spacious" />}\n\t\t\ttestId="basicTestId"\n\t\t>\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);'],
|
|
207
207
|
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'],
|
|
208
208
|
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'],
|
|
209
209
|
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'],
|
|
@@ -227,7 +227,7 @@ var components = exports.components = [{
|
|
|
227
227
|
category: 'overlay',
|
|
228
228
|
description: 'A component for creating overlay backgrounds behind modals and other layered content.',
|
|
229
229
|
status: 'general-availability',
|
|
230
|
-
examples: ["import Blanket from '@atlaskit/blanket';\
|
|
230
|
+
examples: ["import Blanket from '@atlaskit/blanket';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<Blanket />\n\t\t<Blanket isTinted onBlanketClicked={() => console.log('Blanket clicked')} />\n\t</>\n);\nexport default Examples;"],
|
|
231
231
|
accessibilityGuidelines: ["Ensure blanket doesn't interfere with focus management", 'Provide appropriate click handling for dismissal', 'Consider screen reader experience with overlays'],
|
|
232
232
|
usageGuidelines: ['Use behind modals and overlays', 'Consider click-to-dismiss behavior', 'Use appropriate tinting for context', 'Ensure proper z-index layering'],
|
|
233
233
|
contentGuidelines: ['Use consistently across similar overlay contexts', 'Consider visual hierarchy with overlays', 'Ensure appropriate contrast with content'],
|
|
@@ -255,7 +255,7 @@ var components = exports.components = [{
|
|
|
255
255
|
category: 'navigation',
|
|
256
256
|
description: 'A navigation component showing the current page hierarchy.',
|
|
257
257
|
status: 'general-availability',
|
|
258
|
-
examples: ['import Breadcrumbs, { BreadcrumbsItem } from \'@atlaskit/breadcrumbs\';\
|
|
258
|
+
examples: ['import Breadcrumbs, { BreadcrumbsItem } from \'@atlaskit/breadcrumbs\';\nconst Example = (): React.JSX.Element => (\n\t<Breadcrumbs maxItems={3}>\n\t\t<BreadcrumbsItem href="/" text="Home" />\n\t\t<BreadcrumbsItem href="/category" text="Category" />\n\t\t<BreadcrumbsItem href="/category/products" text="Products" />\n\t\t<BreadcrumbsItem text="Current Page" />\n\t</Breadcrumbs>\n);\nexport default Example;'],
|
|
259
259
|
accessibilityGuidelines: ['Provide clear navigation labels', 'Use appropriate ARIA landmarks', 'Ensure keyboard navigation support', 'Provide clear path context'],
|
|
260
260
|
usageGuidelines: ['Use to show page hierarchy', 'Keep breadcrumb labels concise', 'Consider truncation for long paths', 'Use appropriate separators'],
|
|
261
261
|
contentGuidelines: ['Use clear, descriptive page labels', 'Keep labels concise but meaningful', 'Use consistent naming conventions', 'Consider user understanding of hierarchy'],
|
|
@@ -303,7 +303,7 @@ var components = exports.components = [{
|
|
|
303
303
|
category: 'form',
|
|
304
304
|
description: 'A versatile button component with multiple appearances and states for triggering actions. A button triggers an event or action. They let users know what will happen next. Note the root entrypoint of `@atlaskit/button` is deprecated and being replaced with `@atlaskit/button/new`.',
|
|
305
305
|
status: 'general-availability',
|
|
306
|
-
examples: ['import Button from \'@atlaskit/button/new\';\nexport default function ButtonDisabledExample() {\n\treturn (\n\t\t<Button appearance="primary" isDisabled>\n\t\t\tDisabled button\n\t\t</Button>\n\t);\n}', 'import Button from \'@atlaskit/button/new\';\nexport default function ButtonDangerExample() {\n\treturn <Button appearance="danger">Danger button</Button>;\n}', "import Button from '@atlaskit/button/new';\nimport StarIcon from '@atlaskit/icon/core/star-starred';\nexport default function ButtonIconAfterExample() {\n\treturn (\n\t\t<Button iconAfter={StarIcon} appearance=\"primary\">\n\t\t\tIcon after\n\t\t</Button>\n\t);\n}"],
|
|
306
|
+
examples: ['import Button from \'@atlaskit/button/new\';\nexport default function ButtonDisabledExample(): React.JSX.Element {\n\treturn (\n\t\t<Button appearance="primary" isDisabled>\n\t\t\tDisabled button\n\t\t</Button>\n\t);\n}', 'import Button from \'@atlaskit/button/new\';\nexport default function ButtonDangerExample(): React.JSX.Element {\n\treturn <Button appearance="danger">Danger button</Button>;\n}', "import Button from '@atlaskit/button/new';\nimport StarIcon from '@atlaskit/icon/core/star-starred';\nexport default function ButtonIconAfterExample(): React.JSX.Element {\n\treturn (\n\t\t<Button iconAfter={StarIcon} appearance=\"primary\">\n\t\t\tIcon after\n\t\t</Button>\n\t);\n}"],
|
|
307
307
|
accessibilityGuidelines: ['Always provide meaningful labels for screen readers', 'Provide loading state announcements for async actions'],
|
|
308
308
|
usageGuidelines: ['Use primary buttons for the main action on a page', 'Limit to one primary button per section', 'Use subtle buttons for secondary actions', 'Use danger buttons sparingly for destructive actions', 'Group related buttons together with ButtonGroup'],
|
|
309
309
|
contentGuidelines: ['Use action verbs that describe the interaction', 'Keep text concise (1-3 words ideal)', 'Avoid generic terms like "Submit" or "Click here"', 'Use sentence case', 'Use buttons for actions, links for navigation', 'Only include one primary call to action (CTA) per area', "Start with the verb and specify what's being acted on", "Don't use punctuation in button labels"],
|
|
@@ -548,7 +548,7 @@ var components = exports.components = [{
|
|
|
548
548
|
category: 'form',
|
|
549
549
|
description: 'Legacy button component (deprecated). Use Button from @atlaskit/button/new instead.',
|
|
550
550
|
status: 'intent-to-deprecate',
|
|
551
|
-
examples: ["import Button from '@atlaskit/button';\nexport default () => <Button>Button</Button>;"],
|
|
551
|
+
examples: ["import Button from '@atlaskit/button';\nexport default (): React.JSX.Element => <Button>Button</Button>;"],
|
|
552
552
|
accessibilityGuidelines: ['Always provide meaningful labels for screen readers', 'Provide loading state announcements for async actions'],
|
|
553
553
|
usageGuidelines: ['Use the new Button component from @atlaskit/button/new instead', 'Migrate existing usage to the new Button API', 'Consider this component deprecated'],
|
|
554
554
|
contentGuidelines: ['Use action verbs that describe the interaction', 'Keep text concise (1-3 words ideal)', "Avoid generic terms like 'Submit' or 'Click here'"],
|
|
@@ -628,7 +628,7 @@ var components = exports.components = [{
|
|
|
628
628
|
category: 'form',
|
|
629
629
|
description: "A calendar component for date selection and display. This component is in Beta phase, meaning it's stable at version 1.0+ but may receive improvements based on customer feedback.",
|
|
630
630
|
status: 'general-availability',
|
|
631
|
-
examples: ["import Calendar from '@atlaskit/calendar';\
|
|
631
|
+
examples: ["import Calendar from '@atlaskit/calendar';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<Calendar\n\t\t\tselected={['2024-03-15']}\n\t\t\tonChange={(dates) => console.log('Selected dates:', dates)}\n\t\t/>\n\t\t<Calendar\n\t\t\tselected={['2024-03-20', '2024-03-21', '2024-03-22']}\n\t\t\tonChange={(dates) => console.log('Multiple dates:', dates)}\n\t\t\tdefaultMonth={3}\n\t\t\tdefaultYear={2024}\n\t\t/>\n\t\t<Calendar\n\t\t\tselected={[]}\n\t\t\tdisabled={['2024-03-10', '2024-03-11']}\n\t\t\tminDate=\"2024-03-01\"\n\t\t\tmaxDate=\"2024-03-31\"\n\t\t\tonChange={(dates) => console.log('Constrained dates:', dates)}\n\t\t/>\n\t</>\n);\nexport default Examples;"],
|
|
632
632
|
accessibilityGuidelines: ['Provide clear date selection feedback', 'Ensure keyboard navigation between dates', 'Use appropriate ARIA labels for dates', 'Support screen reader announcements for date changes'],
|
|
633
633
|
usageGuidelines: ['Use for date selection interfaces', 'Consider date range limitations', 'Provide clear visual feedback for selected dates', 'Handle disabled dates appropriately'],
|
|
634
634
|
contentGuidelines: ['Use clear date formatting', 'Provide helpful date labels', 'Consider localization for date display', 'Use consistent date terminology'],
|
|
@@ -740,7 +740,7 @@ var components = exports.components = [{
|
|
|
740
740
|
category: 'forms-and-input',
|
|
741
741
|
description: 'A checkbox is an input control that allows a user to select one or more options from a number of choices.',
|
|
742
742
|
status: 'general-availability',
|
|
743
|
-
examples: ['import Checkbox from \'@atlaskit/checkbox\';\
|
|
743
|
+
examples: ['import Checkbox from \'@atlaskit/checkbox\';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<Checkbox label="Basic checkbox" />\n\t\t<Checkbox label="Checked checkbox" isChecked />\n\t</>\n);\nexport default Examples;'],
|
|
744
744
|
accessibilityGuidelines: ['Ensure proper labeling for all checkboxes', 'Use clear, descriptive labels that explain the choice', 'Provide keyboard navigation support', 'Indicate required fields clearly', 'Use appropriate error states and messaging'],
|
|
745
745
|
usageGuidelines: ['Use for multiple choice selections', 'Group related checkboxes logically', 'Provide clear labels for each option', 'Use indeterminate state for partial selections', 'Consider default states carefully'],
|
|
746
746
|
contentGuidelines: ['Write clear, descriptive labels', 'Use consistent language across related options', 'Avoid negative phrasing when possible', 'Group related options together'],
|
|
@@ -888,7 +888,7 @@ var components = exports.components = [{
|
|
|
888
888
|
category: 'data-display',
|
|
889
889
|
description: 'A component for displaying comments and discussions.',
|
|
890
890
|
status: 'general-availability',
|
|
891
|
-
examples: ['import Comment from \'@atlaskit/comment\';\
|
|
891
|
+
examples: ['import Comment from \'@atlaskit/comment\';\nconst Example = (): React.JSX.Element => (\n\t<Comment\n\t\tauthor="Bob Johnson"\n\t\ttime="30 minutes ago"\n\t\tcontent="Another comment in the thread"\n\t\tavatar="https://picsum.photos/32/32"\n\t/>\n);\nexport default Example;'],
|
|
892
892
|
accessibilityGuidelines: ['Ensure proper comment structure', 'Provide clear comment attribution', 'Use appropriate heading hierarchy', 'Consider screen reader navigation'],
|
|
893
893
|
usageGuidelines: ['Use for comment threads and discussions', 'Provide clear comment attribution', 'Handle comment nesting appropriately', 'Consider comment moderation features'],
|
|
894
894
|
contentGuidelines: ['Use clear, constructive comment content', 'Provide meaningful comment attribution', 'Use appropriate comment formatting', 'Consider comment context and purpose'],
|
|
@@ -980,7 +980,7 @@ var components = exports.components = [{
|
|
|
980
980
|
category: 'form',
|
|
981
981
|
description: 'A component for selecting date values with calendar support.',
|
|
982
982
|
status: 'general-availability',
|
|
983
|
-
examples: ['import { DatePicker } from \'@atlaskit/datetime-picker\';\
|
|
983
|
+
examples: ['import { DatePicker } from \'@atlaskit/datetime-picker\';\nconst Example = (): React.JSX.Element => (\n\t<DatePicker\n\t\tclearControlLabel="Clear select date"\n\t\tonChange={() => {}}\n\t\tshouldShowCalendarButton\n\t\topenCalendarLabel="open calendar"\n\t/>\n);\nexport default Example;'],
|
|
984
984
|
accessibilityGuidelines: ['Ensure proper keyboard navigation', 'Use appropriate date formats', 'Provide clear date labels', 'Consider screen reader announcements'],
|
|
985
985
|
usageGuidelines: ['Use for date selection only', 'Provide clear date formats', 'Handle date validation appropriately', 'Consider calendar button visibility'],
|
|
986
986
|
contentGuidelines: ['Use clear, descriptive labels', 'Provide helpful placeholder text', 'Use appropriate date formats', 'Keep labels concise but descriptive'],
|
|
@@ -1128,7 +1128,7 @@ var components = exports.components = [{
|
|
|
1128
1128
|
category: 'form',
|
|
1129
1129
|
description: 'A component for selecting time values with clock interface.',
|
|
1130
1130
|
status: 'general-availability',
|
|
1131
|
-
examples: ['import { TimePicker } from \'@atlaskit/datetime-picker\';\
|
|
1131
|
+
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={() => {}}\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;'],
|
|
1132
1132
|
accessibilityGuidelines: ['Ensure proper keyboard navigation', 'Use appropriate time formats', 'Provide clear time labels', 'Consider screen reader announcements'],
|
|
1133
1133
|
usageGuidelines: ['Use for time selection only', 'Provide clear time formats', 'Handle time validation appropriately', 'Consider editable time input'],
|
|
1134
1134
|
contentGuidelines: ['Use clear, descriptive labels', 'Provide helpful placeholder text', 'Use appropriate time formats', 'Keep labels concise but descriptive'],
|
|
@@ -1240,7 +1240,7 @@ var components = exports.components = [{
|
|
|
1240
1240
|
category: 'form',
|
|
1241
1241
|
description: 'A component for selecting both date and time values.',
|
|
1242
1242
|
status: 'general-availability',
|
|
1243
|
-
examples: ["import { DateTimePicker } from '@atlaskit/datetime-picker';\
|
|
1243
|
+
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={() => {}}\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;"],
|
|
1244
1244
|
accessibilityGuidelines: ['Ensure proper keyboard navigation', 'Use appropriate date/time formats', 'Provide clear date/time labels', 'Consider screen reader announcements'],
|
|
1245
1245
|
usageGuidelines: ['Use for combined date and time selection', 'Provide clear date/time formats', 'Handle timezone considerations', 'Consider validation requirements'],
|
|
1246
1246
|
contentGuidelines: ['Use clear, descriptive labels', 'Provide helpful placeholder text', 'Use appropriate date/time formats', 'Keep labels concise but descriptive'],
|
|
@@ -1392,7 +1392,7 @@ var components = exports.components = [{
|
|
|
1392
1392
|
category: 'overlays-and-layering',
|
|
1393
1393
|
description: 'The main content area of a drawer panel.',
|
|
1394
1394
|
status: 'intent-to-deprecate',
|
|
1395
|
-
examples: ["import { DrawerContent } from '@atlaskit/drawer';\nimport Heading from '@atlaskit/heading';\nimport { Text } from '@atlaskit/primitives/compiled';\
|
|
1395
|
+
examples: ["import { DrawerContent } from '@atlaskit/drawer';\nimport Heading from '@atlaskit/heading';\nimport { Text } from '@atlaskit/primitives/compiled';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<DrawerContent>\n\t\t\t<Heading size=\"large\">Content Title</Heading>\n\t\t\t<Text>This is the main content area of the drawer.</Text>\n\t\t</DrawerContent>\n\t\t<DrawerContent>\n\t\t\t<Heading size=\"medium\">Settings</Heading>\n\t\t\t<Text>Configure your preferences here.</Text>\n\t\t</DrawerContent>\n\t</>\n);\nexport default Examples;"],
|
|
1396
1396
|
usageGuidelines: ['Use as the main content container within a drawer', 'Place primary content and actions here', 'Ensure proper scrolling behavior for long content'],
|
|
1397
1397
|
contentGuidelines: ['Organize content logically', 'Use appropriate spacing and layout', 'Consider content hierarchy'],
|
|
1398
1398
|
props: [{
|
|
@@ -1415,7 +1415,7 @@ var components = exports.components = [{
|
|
|
1415
1415
|
category: 'overlays-and-layering',
|
|
1416
1416
|
description: 'A sidebar component within a drawer for navigation or secondary content.',
|
|
1417
1417
|
status: 'intent-to-deprecate',
|
|
1418
|
-
examples: ["import { DrawerCloseButton, DrawerSidebar } from '@atlaskit/drawer';\
|
|
1418
|
+
examples: ["import { DrawerCloseButton, DrawerSidebar } from '@atlaskit/drawer';\nconst Example = (): React.JSX.Element => (\n\t<DrawerSidebar>\n\t\t<DrawerCloseButton />\n\t</DrawerSidebar>\n);\nexport default Example;"],
|
|
1419
1419
|
usageGuidelines: ['Use for navigation or secondary content in a drawer', 'Keep sidebar content focused and organized', 'Consider responsive behavior'],
|
|
1420
1420
|
contentGuidelines: ['Use clear navigation labels', 'Organize content hierarchically', 'Keep sidebar content concise'],
|
|
1421
1421
|
props: [{
|
|
@@ -1434,7 +1434,7 @@ var components = exports.components = [{
|
|
|
1434
1434
|
category: 'overlays-and-layering',
|
|
1435
1435
|
description: 'A close button specifically designed for drawer components.',
|
|
1436
1436
|
status: 'intent-to-deprecate',
|
|
1437
|
-
examples: ["import { DrawerCloseButton } from '@atlaskit/drawer';\
|
|
1437
|
+
examples: ["import { DrawerCloseButton } from '@atlaskit/drawer';\nconst Example = (): React.JSX.Element => <DrawerCloseButton />;\nexport default Example;"],
|
|
1438
1438
|
usageGuidelines: ['Use to provide clear close functionality for drawers', 'Position prominently for easy access', 'Ensure keyboard accessibility'],
|
|
1439
1439
|
contentGuidelines: ['Use clear close icon or text', 'Ensure button is easily discoverable', 'Provide appropriate hover/focus states'],
|
|
1440
1440
|
props: [{
|
|
@@ -1453,7 +1453,7 @@ var components = exports.components = [{
|
|
|
1453
1453
|
category: 'navigation',
|
|
1454
1454
|
description: 'A dropdown menu component for displaying contextual actions and options.',
|
|
1455
1455
|
status: 'general-availability',
|
|
1456
|
-
examples: ['import { IconButton } from \'@atlaskit/button/new\';\nimport DropdownMenu, { DropdownItem, DropdownItemGroup } from \'@atlaskit/dropdown-menu\';\nimport MoreIcon from \'@atlaskit/icon/core/show-more-horizontal\';\
|
|
1456
|
+
examples: ['import { IconButton } from \'@atlaskit/button/new\';\nimport DropdownMenu, { DropdownItem, DropdownItemGroup } from \'@atlaskit/dropdown-menu\';\nimport MoreIcon from \'@atlaskit/icon/core/show-more-horizontal\';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<DropdownMenu\n\t\t\tshouldRenderToParent\n\t\t\ttrigger={({ triggerRef, ...props }) => (\n\t\t\t\t<IconButton ref={triggerRef} {...props} icon={MoreIcon} label="More" />\n\t\t\t)}\n\t\t>\n\t\t\t<DropdownItemGroup>\n\t\t\t\t<DropdownItem href="/dashboard">Dashboard</DropdownItem>\n\t\t\t\t<DropdownItem>Create</DropdownItem>\n\t\t\t\t<DropdownItem>Delete</DropdownItem>\n\t\t\t</DropdownItemGroup>\n\t\t</DropdownMenu>\n\t\t<DropdownMenu shouldRenderToParent trigger="Actions">\n\t\t\t<DropdownItemGroup>\n\t\t\t\t<DropdownItem>Export</DropdownItem>\n\t\t\t\t<DropdownItem>Share</DropdownItem>\n\t\t\t</DropdownItemGroup>\n\t\t</DropdownMenu>\n\t</>\n);\nexport default Examples;'],
|
|
1457
1457
|
accessibilityGuidelines: ['Provide clear labels for dropdown triggers', 'Ensure keyboard navigation with arrow keys', 'Use appropriate ARIA attributes', 'Provide clear menu item descriptions', 'Support escape key to close menu'],
|
|
1458
1458
|
usageGuidelines: ['Use for contextual actions and options', 'Group related menu items together', 'Use clear, descriptive menu item labels', 'Consider menu positioning and overflow', 'Use appropriate trigger elements'],
|
|
1459
1459
|
contentGuidelines: ['Use clear, action-oriented menu item labels', 'Keep menu item text concise', 'Group related actions logically', 'Use consistent terminology across menu items'],
|
|
@@ -1541,7 +1541,7 @@ var components = exports.components = [{
|
|
|
1541
1541
|
category: 'status',
|
|
1542
1542
|
description: 'A component for empty states.',
|
|
1543
1543
|
status: 'general-availability',
|
|
1544
|
-
examples: ['import EmptyState from \'@atlaskit/empty-state\';\
|
|
1544
|
+
examples: ['import EmptyState from \'@atlaskit/empty-state\';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<EmptyState header="No items" description="Add items to get started" />\n\t\t<EmptyState\n\t\t\theader="No search results"\n\t\t\tdescription="Try adjusting your search criteria or browse all items."\n\t\t/>\n\t\t<EmptyState\n\t\t\theader="Welcome to your dashboard"\n\t\t\tdescription="Create your first project to get started with the platform."\n\t\t/>\n\t</>\n);\nexport default Examples;'],
|
|
1545
1545
|
accessibilityGuidelines: ['Provide clear empty state messaging', 'Use appropriate headings and structure', 'Ensure actionable content is accessible', 'Consider screen reader experience'],
|
|
1546
1546
|
usageGuidelines: ['Use when nothing to display in a view', 'Explain why the state is empty', 'Provide clear next steps', 'Keep tone helpful and encouraging', 'Consider all scenarios causing the empty state'],
|
|
1547
1547
|
contentGuidelines: ['Use inspirational, motivating tone for first-time view', 'Provide specific next steps', 'Avoid negative language', 'Use clear, descriptive headers'],
|
|
@@ -1617,7 +1617,7 @@ var components = exports.components = [{
|
|
|
1617
1617
|
category: 'feedback',
|
|
1618
1618
|
description: 'A component for displaying brief messages.',
|
|
1619
1619
|
status: 'general-availability',
|
|
1620
|
-
examples: ['import Flag, { FlagGroup } from \'@atlaskit/flag\';\nimport InfoIcon from \'@atlaskit/icon/core/status-information\';\
|
|
1620
|
+
examples: ['import Flag, { FlagGroup } from \'@atlaskit/flag\';\nimport InfoIcon from \'@atlaskit/icon/core/status-information\';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<FlagGroup>\n\t\t\t<Flag\n\t\t\t\tid="flag-1"\n\t\t\t\ticon={<InfoIcon label="Info" />}\n\t\t\t\ttitle="Success"\n\t\t\t\tdescription="Your changes have been saved successfully."\n\t\t\t\tappearance="success"\n\t\t\t/>\n\t\t</FlagGroup>\n\t\t<FlagGroup>\n\t\t\t<Flag\n\t\t\t\tid="flag-2"\n\t\t\t\ticon={<InfoIcon label="Warning" />}\n\t\t\t\ttitle="Warning"\n\t\t\t\tdescription="This action cannot be undone."\n\t\t\t\tappearance="warning"\n\t\t\t\tactions={[\n\t\t\t\t\t{\n\t\t\t\t\t\tcontent: \'Proceed\',\n\t\t\t\t\t\tonClick: () => console.log(\'Proceed clicked\'),\n\t\t\t\t\t},\n\t\t\t\t]}\n\t\t\t/>\n\t\t</FlagGroup>\n\t\t<FlagGroup>\n\t\t\t<Flag\n\t\t\t\tid="flag-3"\n\t\t\t\ticon={<InfoIcon label="Error" />}\n\t\t\t\ttitle="Error"\n\t\t\t\tdescription="Something went wrong. Please try again."\n\t\t\t\tappearance="error"\n\t\t\t\tactions={[\n\t\t\t\t\t{\n\t\t\t\t\t\tcontent: \'Retry\',\n\t\t\t\t\t\tonClick: () => console.log(\'Retry clicked\'),\n\t\t\t\t\t},\n\t\t\t\t]}\n\t\t\t/>\n\t\t</FlagGroup>\n\t</>\n);\nexport default Examples;'],
|
|
1621
1621
|
accessibilityGuidelines: ['Ensure flag content is announced by screen readers', 'Use appropriate timing for auto-dismiss', 'Provide clear action options', 'Consider screen reader announcement conflicts', 'Use an h2 heading level for the title', 'Use the `headingLevel` prop to maintain proper heading hierarchy'],
|
|
1622
1622
|
usageGuidelines: ['Use for confirmations and alerts needing minimal interaction', 'Display event-driven messages', 'Position at bottom left of screen', 'Consider auto-dismiss timing'],
|
|
1623
1623
|
contentGuidelines: ['Be clear about what went wrong for errors', 'Provide specific steps to resolve issues', 'Use a helpful, non-threatening tone', 'Clearly state potential consequences for warnings', 'Confirm outcome then get out of the way for success messages'],
|
|
@@ -1629,6 +1629,10 @@ var components = exports.components = [{
|
|
|
1629
1629
|
name: 'appearance',
|
|
1630
1630
|
description: "Makes the flag appearance bold. Setting this to anything other than 'normal' hides the\ndismiss button.",
|
|
1631
1631
|
type: '"error" | "info" | "success" | "warning" | "normal"'
|
|
1632
|
+
}, {
|
|
1633
|
+
name: 'autoDismissSeconds',
|
|
1634
|
+
description: 'Duration in seconds before flag gets auto dismissed.\nDefault is 8 seconds. For a11y reasons 8s is also a strongly-suggested minimum.\nOnly applies to auto-dismissable flags.',
|
|
1635
|
+
type: 'number'
|
|
1632
1636
|
}, {
|
|
1633
1637
|
name: 'delayAnnouncement',
|
|
1634
1638
|
description: 'Milliseconds to delay the screen reader announcement due to announcement conflict.',
|
|
@@ -1685,7 +1689,7 @@ var components = exports.components = [{
|
|
|
1685
1689
|
category: 'form',
|
|
1686
1690
|
description: 'A component for building forms with validation and state management.',
|
|
1687
1691
|
status: 'general-availability',
|
|
1688
|
-
examples: ['import Button from \'@atlaskit/button/new\';\nimport { Checkbox } from \'@atlaskit/checkbox\';\nimport Form, { CheckboxField, ErrorMessage, Field, FormFooter, FormHeader } from \'@atlaskit/form\';\nimport TextField from \'@atlaskit/textfield\';\
|
|
1692
|
+
examples: ['import Button from \'@atlaskit/button/new\';\nimport { Checkbox } from \'@atlaskit/checkbox\';\nimport Form, { CheckboxField, ErrorMessage, Field, FormFooter, FormHeader } from \'@atlaskit/form\';\nimport TextField from \'@atlaskit/textfield\';\nconst Example = (): React.JSX.Element => (\n\t<Form onSubmit={(data) => console.log(\'validated form\', data)}>\n\t\t<FormHeader title="Basic Form">\n\t\t\t<p>Fill out the form below</p>\n\t\t</FormHeader>\n\t\t<Field\n\t\t\tname="username"\n\t\t\tlabel="Username"\n\t\t\tisRequired\n\t\t\tvalidate={(value) => (value && value.length < 3 ? \'Too short\' : undefined)}\n\t\t>\n\t\t\t{({ fieldProps, error }) => (\n\t\t\t\t<>\n\t\t\t\t\t<TextField {...fieldProps} />\n\t\t\t\t\t{error && <ErrorMessage>Username must be at least 3 characters</ErrorMessage>}\n\t\t\t\t</>\n\t\t\t)}\n\t\t</Field>\n\t\t<CheckboxField name="terms" value="terms">\n\t\t\t{({ fieldProps }) => <Checkbox {...fieldProps} label="I accept the terms" />}\n\t\t</CheckboxField>\n\t\t<FormFooter>\n\t\t\t<Button type="submit" appearance="primary">\n\t\t\t\tCreate Account\n\t\t\t</Button>\n\t\t</FormFooter>\n\t</Form>\n);\nexport default Example;'],
|
|
1689
1693
|
accessibilityGuidelines: ['Provide clear labels for all form fields', 'Use appropriate error messaging', 'Ensure keyboard navigation between fields', 'Mark required fields clearly', 'Provide helpful validation feedback'],
|
|
1690
1694
|
usageGuidelines: ['Use for complex forms with validation', 'Provide clear field labels and instructions', 'Use single column layout for better comprehension', 'Mark required fields with asterisk (*)', 'Provide specific error messages'],
|
|
1691
1695
|
contentGuidelines: ['Use clear, concise labels', 'Write helpful placeholder text', 'Provide specific error messages', 'Use consistent terminology', 'Always include a visible label (exception: search fields)', 'Match field length to intended content length'],
|
|
@@ -1732,7 +1736,7 @@ var components = exports.components = [{
|
|
|
1732
1736
|
}, {
|
|
1733
1737
|
name: 'xcss',
|
|
1734
1738
|
description: 'Apply a subset of permitted styles powered by Atlassian Design System design tokens.',
|
|
1735
|
-
type: 'false | (XCSSValue<"flex" | "grid" | "fill" | "stroke" | "all" | "bottom" | "left" | "right" | "top" | "clip" | "
|
|
1739
|
+
type: 'false | (XCSSValue<"flex" | "grid" | "fill" | "stroke" | "all" | "bottom" | "left" | "right" | "top" | "clip" | "overlay" | "accentColor" | "alignContent" | "alignItems" | "alignSelf" | ... 486 more ... | "glyphOrientationVertical", DesignTokenStyles, ""> & ... 4 more ... & { ...; })'
|
|
1736
1740
|
}]
|
|
1737
1741
|
}, {
|
|
1738
1742
|
name: 'Heading',
|
|
@@ -1864,7 +1868,7 @@ var components = exports.components = [{
|
|
|
1864
1868
|
category: 'data-display',
|
|
1865
1869
|
description: 'A component for displaying images with theme support.',
|
|
1866
1870
|
status: 'open-beta',
|
|
1867
|
-
examples: ['import Image from \'@atlaskit/image\';\
|
|
1871
|
+
examples: ['import Image from \'@atlaskit/image\';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<Image src="https://picsum.photos/300/150" alt="Wide view" width={300} height={150} />\n\t\t<Image src="https://picsum.photos/100/100" alt="User profile" width={100} height={100} />\n\t</>\n);\nexport default Examples;'],
|
|
1868
1872
|
accessibilityGuidelines: ['Always provide meaningful alt text', 'Ensure appropriate image sizing', 'Consider loading states and error handling', 'Use appropriate image formats'],
|
|
1869
1873
|
usageGuidelines: ['Use for displaying images in content', 'Provide appropriate alt text', 'Consider responsive image sizing', 'Handle loading and error states'],
|
|
1870
1874
|
contentGuidelines: ['Use clear, descriptive alt text', 'Choose appropriate image dimensions', 'Consider image quality and file size', 'Use meaningful image content'],
|
|
@@ -1880,7 +1884,7 @@ var components = exports.components = [{
|
|
|
1880
1884
|
category: 'overlay',
|
|
1881
1885
|
description: 'A component for displaying content in an inline dialog.',
|
|
1882
1886
|
status: 'general-availability',
|
|
1883
|
-
examples: ["import Button from '@atlaskit/button/new';\nimport Heading from '@atlaskit/heading';\nimport InlineDialog from '@atlaskit/inline-dialog';\nimport { Text } from '@atlaskit/primitives/compiled';\
|
|
1887
|
+
examples: ["import Button from '@atlaskit/button/new';\nimport Heading from '@atlaskit/heading';\nimport InlineDialog from '@atlaskit/inline-dialog';\nimport { Text } from '@atlaskit/primitives/compiled';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<InlineDialog content={<div>This is an inline dialog</div>} isOpen={true}>\n\t\t\t<Button>Trigger</Button>\n\t\t</InlineDialog>\n\t\t<InlineDialog\n\t\t\tcontent={\n\t\t\t\t<div>\n\t\t\t\t\t<Heading size=\"large\">Dialog Title</Heading>\n\t\t\t\t\t<Text>Dialog content goes here</Text>\n\t\t\t\t</div>\n\t\t\t}\n\t\t\tisOpen={false}\n\t\t>\n\t\t\t<Button>Open Dialog</Button>\n\t\t</InlineDialog>\n\t</>\n);\nexport default Examples;"],
|
|
1884
1888
|
accessibilityGuidelines: ['Ensure proper focus management', 'Provide clear dialog labels', 'Use appropriate ARIA attributes', 'Consider keyboard navigation'],
|
|
1885
1889
|
usageGuidelines: ['Use for contextual information display', 'Position appropriately relative to trigger', 'Consider dialog sizing and content', 'Handle focus and escape key behavior'],
|
|
1886
1890
|
contentGuidelines: ['Use clear, concise dialog content', 'Provide meaningful dialog titles', 'Keep content focused and relevant', 'Use appropriate dialog sizing'],
|
|
@@ -1932,7 +1936,7 @@ var components = exports.components = [{
|
|
|
1932
1936
|
category: 'form',
|
|
1933
1937
|
description: 'A component for inline editing of text content.',
|
|
1934
1938
|
status: 'general-availability',
|
|
1935
|
-
examples: ['import InlineEdit from \'@atlaskit/inline-edit\';\
|
|
1939
|
+
examples: ['import InlineEdit from \'@atlaskit/inline-edit\';\nconst Example = (): React.JSX.Element => (\n\t<InlineEdit\n\t\tonConfirm={() => {}}\n\t\tonCancel={() => {}}\n\t\tdefaultValue="Editable text"\n\t\teditView={() => <div>Edit view</div>}\n\t\treadView={() => <div>Read view</div>}\n\t/>\n);\nexport default Example;'],
|
|
1936
1940
|
accessibilityGuidelines: ['Ensure proper focus management', 'Provide clear edit state indicators', 'Use appropriate ARIA attributes', 'Consider keyboard navigation'],
|
|
1937
1941
|
usageGuidelines: ['Use for inline text editing', 'Provide clear edit state indicators', 'Handle save and cancel actions', 'Consider validation requirements'],
|
|
1938
1942
|
contentGuidelines: ['Use clear, descriptive text content', 'Provide helpful placeholder text', 'Use appropriate validation messages', 'Keep content concise but meaningful'],
|
|
@@ -2016,7 +2020,7 @@ var components = exports.components = [{
|
|
|
2016
2020
|
category: 'feedback',
|
|
2017
2021
|
description: 'A component for displaying inline messages and feedback.',
|
|
2018
2022
|
status: 'general-availability',
|
|
2019
|
-
examples: ['import InlineMessage from \'@atlaskit/inline-message\';\
|
|
2023
|
+
examples: ['import InlineMessage from \'@atlaskit/inline-message\';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<InlineMessage\n\t\t\ttitle="Success"\n\t\t\tsecondaryText="Your changes have been saved successfully."\n\t\t\tappearance="confirmation"\n\t\t/>\n\t\t<InlineMessage\n\t\t\ttitle="Warning"\n\t\t\tsecondaryText="This action cannot be undone."\n\t\t\tappearance="warning"\n\t\t/>\n\t\t<InlineMessage\n\t\t\ttitle="Error"\n\t\t\tsecondaryText="Something went wrong. Please try again."\n\t\t\tappearance="error"\n\t\t/>\n\t</>\n);\nexport default Examples;'],
|
|
2020
2024
|
accessibilityGuidelines: ['Ensure message content is announced by screen readers', 'Use appropriate message types and colors', 'Provide clear message context', 'Consider message timing and persistence'],
|
|
2021
2025
|
usageGuidelines: ['Use for inline feedback and messages', 'Choose appropriate message types', 'Position messages near relevant content', 'Consider message timing and dismissal'],
|
|
2022
2026
|
contentGuidelines: ['Use clear, concise message text', 'Provide specific, actionable feedback', 'Use appropriate tone for message type', 'Keep messages focused and relevant'],
|
|
@@ -2125,19 +2129,15 @@ var components = exports.components = [{
|
|
|
2125
2129
|
contentGuidelines: ['Use clear, concise text', 'Ensure text is meaningful and descriptive', 'Use consistent terminology across lozenges', 'Consider text length and readability'],
|
|
2126
2130
|
props: [{
|
|
2127
2131
|
name: 'appearance',
|
|
2128
|
-
description: 'The appearance type.',
|
|
2129
|
-
type: '"
|
|
2132
|
+
description: 'The appearance type.\nThe appearance of the lozenge. Supports both legacy semantic appearances and new accent/semantic colors.\nLegacy appearances (default, success, removed, inprogress, new, moved) are automatically mapped to the new semantic colors.',
|
|
2133
|
+
type: 'ThemeAppearance | "warning" | "danger" | "information" | "neutral" | "discovery" | "accent-red" | "accent-orange" | "accent-yellow" | "accent-lime" | "accent-green" | ... 4 more ... | "accent-gray"'
|
|
2130
2134
|
}, {
|
|
2131
2135
|
name: 'children',
|
|
2132
|
-
description: 'Elements to be rendered inside the lozenge. This should ideally be just a word or two.',
|
|
2136
|
+
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.',
|
|
2133
2137
|
type: 'string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal'
|
|
2134
|
-
}, {
|
|
2135
|
-
name: 'isBold',
|
|
2136
|
-
description: 'Determines whether to apply the bold style or not.',
|
|
2137
|
-
type: 'boolean'
|
|
2138
2138
|
}, {
|
|
2139
2139
|
name: 'maxWidth',
|
|
2140
|
-
description: 'max-width of lozenge container. Default to 200px.',
|
|
2140
|
+
description: 'max-width of lozenge container. Default to 200px.\nmax-width of lozenge container. Default to 200px.',
|
|
2141
2141
|
type: 'string | number'
|
|
2142
2142
|
}]
|
|
2143
2143
|
}, {
|
|
@@ -2147,7 +2147,7 @@ var components = exports.components = [{
|
|
|
2147
2147
|
category: 'navigation',
|
|
2148
2148
|
description: 'A component for displaying menus with grouped items.',
|
|
2149
2149
|
status: 'general-availability',
|
|
2150
|
-
examples: ['import { ButtonItem, LinkItem, MenuGroup, Section } from \'@atlaskit/menu\';\
|
|
2150
|
+
examples: ['import { ButtonItem, LinkItem, MenuGroup, Section } from \'@atlaskit/menu\';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<MenuGroup spacing="cozy">\n\t\t\t<Section title="Navigation">\n\t\t\t\t<LinkItem href="/dashboard">Dashboard</LinkItem>\n\t\t\t\t<LinkItem href="/projects">Projects</LinkItem>\n\t\t\t\t<LinkItem href="/settings">Settings</LinkItem>\n\t\t\t</Section>\n\t\t</MenuGroup>\n\t\t<MenuGroup spacing="compact">\n\t\t\t<Section title="Actions">\n\t\t\t\t<ButtonItem>Create New</ButtonItem>\n\t\t\t\t<ButtonItem>Import</ButtonItem>\n\t\t\t\t<ButtonItem>Export</ButtonItem>\n\t\t\t</Section>\n\t\t\t<Section title="Help">\n\t\t\t\t<LinkItem href="/docs">Documentation</LinkItem>\n\t\t\t\t<LinkItem href="/support">Support</LinkItem>\n\t\t\t</Section>\n\t\t</MenuGroup>\n\t</>\n);\nexport default Examples;'],
|
|
2151
2151
|
accessibilityGuidelines: ['Provide clear menu item labels', 'Use appropriate ARIA attributes', 'Ensure keyboard navigation with arrow keys', 'Provide clear section titles'],
|
|
2152
2152
|
usageGuidelines: ['Use for organizing menu items into sections', 'Group related menu items together', 'Use clear section titles', 'Consider menu density and spacing'],
|
|
2153
2153
|
contentGuidelines: ['Use clear, descriptive menu item labels', 'Group related items logically', 'Use consistent terminology', 'Keep menu structure simple'],
|
|
@@ -2199,15 +2199,11 @@ var components = exports.components = [{
|
|
|
2199
2199
|
category: 'overlay',
|
|
2200
2200
|
description: 'A modal dialog component for important content.',
|
|
2201
2201
|
status: 'general-availability',
|
|
2202
|
-
examples: ['import React, { Fragment, useCallback, useState } from \'react\';\nimport Button from \'@atlaskit/button/new\';\nimport Modal, {\n\tModalBody,\n\tModalFooter,\n\tModalHeader,\n\tModalTitle,\n\tModalTransition,\n} from \'@atlaskit/modal-dialog\';\nimport { Text } from \'@atlaskit/primitives/compiled\';\nexport default function Example() {\n\tconst [isOpen, setIsOpen] = useState(false);\n\tconst openModal = useCallback(() => setIsOpen(true), []);\n\tconst closeModal = useCallback(() => setIsOpen(false), []);\n\treturn (\n\t\t<Fragment>\n\t\t\t<Button aria-haspopup="dialog" appearance="primary" onClick={openModal}>\n\t\t\t\tOpen modal\n\t\t\t</Button>\n\t\t\t<ModalTransition>\n\t\t\t\t{isOpen && (\n\t\t\t\t\t<Modal onClose={closeModal}>\n\t\t\t\t\t\t<ModalHeader hasCloseButton>\n\t\t\t\t\t\t\t<ModalTitle>Duplicate this page</ModalTitle>\n\t\t\t\t\t\t</ModalHeader>\n\t\t\t\t\t\t<ModalBody>\n\t\t\t\t\t\t\tDuplicating this page will make it a child page of{\' \'}\n\t\t\t\t\t\t\t<Text weight="bold">Search - user exploration</Text>, in the{\' \'}\n\t\t\t\t\t\t\t<Text weight="bold">Search & Smarts</Text> space.\n\t\t\t\t\t\t</ModalBody>\n\t\t\t\t\t\t<ModalFooter>\n\t\t\t\t\t\t\t<Button appearance="subtle" onClick={closeModal}>\n\t\t\t\t\t\t\t\tCancel\n\t\t\t\t\t\t\t</Button>\n\t\t\t\t\t\t\t<Button appearance="primary" onClick={closeModal}>\n\t\t\t\t\t\t\t\tDuplicate\n\t\t\t\t\t\t\t</Button>\n\t\t\t\t\t\t</ModalFooter>\n\t\t\t\t\t</Modal>\n\t\t\t\t)}\n\t\t\t</ModalTransition>\n\t\t</Fragment>\n\t);\n}'],
|
|
2202
|
+
examples: ['import React, { Fragment, useCallback, useState } from \'react\';\nimport Button from \'@atlaskit/button/new\';\nimport Modal, {\n\tModalBody,\n\tModalFooter,\n\tModalHeader,\n\tModalTitle,\n\tModalTransition,\n} from \'@atlaskit/modal-dialog\';\nimport { Text } from \'@atlaskit/primitives/compiled\';\nexport default function Example(): React.JSX.Element {\n\tconst [isOpen, setIsOpen] = useState(false);\n\tconst openModal = useCallback(() => setIsOpen(true), []);\n\tconst closeModal = useCallback(() => setIsOpen(false), []);\n\treturn (\n\t\t<Fragment>\n\t\t\t<Button aria-haspopup="dialog" appearance="primary" onClick={openModal}>\n\t\t\t\tOpen modal\n\t\t\t</Button>\n\t\t\t<ModalTransition>\n\t\t\t\t{isOpen && (\n\t\t\t\t\t<Modal onClose={closeModal}>\n\t\t\t\t\t\t<ModalHeader hasCloseButton>\n\t\t\t\t\t\t\t<ModalTitle>Duplicate this page</ModalTitle>\n\t\t\t\t\t\t</ModalHeader>\n\t\t\t\t\t\t<ModalBody>\n\t\t\t\t\t\t\tDuplicating this page will make it a child page of{\' \'}\n\t\t\t\t\t\t\t<Text weight="bold">Search - user exploration</Text>, in the{\' \'}\n\t\t\t\t\t\t\t<Text weight="bold">Search & Smarts</Text> space.\n\t\t\t\t\t\t</ModalBody>\n\t\t\t\t\t\t<ModalFooter>\n\t\t\t\t\t\t\t<Button appearance="subtle" onClick={closeModal}>\n\t\t\t\t\t\t\t\tCancel\n\t\t\t\t\t\t\t</Button>\n\t\t\t\t\t\t\t<Button appearance="primary" onClick={closeModal}>\n\t\t\t\t\t\t\t\tDuplicate\n\t\t\t\t\t\t\t</Button>\n\t\t\t\t\t\t</ModalFooter>\n\t\t\t\t\t</Modal>\n\t\t\t\t)}\n\t\t\t</ModalTransition>\n\t\t</Fragment>\n\t);\n}'],
|
|
2203
2203
|
accessibilityGuidelines: ['Ensure modal content is announced by screen readers', 'Provide appropriate focus management', 'Use clear, descriptive modal titles', 'Ensure keyboard navigation and escape key support', 'Maintain focus within modal when open'],
|
|
2204
2204
|
usageGuidelines: ['Use for important content that requires user attention', 'Keep modal content focused on a single task', 'Provide clear action buttons', 'Use appropriate modal sizes for content', 'Consider mobile responsiveness'],
|
|
2205
2205
|
contentGuidelines: ['Use clear, descriptive titles', 'Keep content focused on a single task or message', 'Include clear action buttons', 'Use sentence case for all text', 'Provide clear next steps'],
|
|
2206
2206
|
props: [{
|
|
2207
|
-
name: 'autoFocus',
|
|
2208
|
-
description: 'Focus is moved to the first interactive element inside the modal dialog\nwhen `true`. It is not recommended to set to `false` as this creates\naccessibility regressions. Pass an element `ref` to focus on a specific element.\n\nDefault value is `true`.',
|
|
2209
|
-
type: 'boolean | React.RefObject<HTMLElement>'
|
|
2210
|
-
}, {
|
|
2211
2207
|
name: 'children',
|
|
2212
2208
|
description: 'Contents of the modal dialog.',
|
|
2213
2209
|
type: 'string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal'
|
|
@@ -2275,7 +2271,7 @@ var components = exports.components = [{
|
|
|
2275
2271
|
category: 'layout',
|
|
2276
2272
|
description: 'A component for page headers.',
|
|
2277
2273
|
status: 'general-availability',
|
|
2278
|
-
examples: ['import Breadcrumbs, { BreadcrumbsItem } from \'@atlaskit/breadcrumbs\';\nimport Button from \'@atlaskit/button/new\';\nimport PageHeader from \'@atlaskit/page-header\';\
|
|
2274
|
+
examples: ['import Breadcrumbs, { BreadcrumbsItem } from \'@atlaskit/breadcrumbs\';\nimport Button from \'@atlaskit/button/new\';\nimport PageHeader from \'@atlaskit/page-header\';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<PageHeader>Page Title</PageHeader>\n\t\t<PageHeader\n\t\t\tbreadcrumbs={\n\t\t\t\t<Breadcrumbs>\n\t\t\t\t\t<BreadcrumbsItem href="/" text="Home" />\n\t\t\t\t\t<BreadcrumbsItem href="/projects" text="Projects" />\n\t\t\t\t\t<BreadcrumbsItem text="Current Project" />\n\t\t\t\t</Breadcrumbs>\n\t\t\t}\n\t\t\tactions={<Button appearance="primary">Create</Button>}\n\t\t>\n\t\t\tProject Settings\n\t\t</PageHeader>\n\t\t<PageHeader\n\t\t\tactions={\n\t\t\t\t<>\n\t\t\t\t\t<Button appearance="subtle">Cancel</Button>\n\t\t\t\t\t<Button appearance="primary">Save Changes</Button>\n\t\t\t\t</>\n\t\t\t}\n\t\t>\n\t\t\tEdit Profile\n\t\t</PageHeader>\n\t</>\n);\nexport default Examples;'],
|
|
2279
2275
|
accessibilityGuidelines: ['Provide clear page titles', 'Use appropriate heading hierarchy', 'Ensure breadcrumb navigation is accessible', 'Provide clear action labels'],
|
|
2280
2276
|
usageGuidelines: ['Use for consistent page header layout', 'Include breadcrumbs for navigation context', 'Provide relevant page actions', 'Use appropriate header hierarchy'],
|
|
2281
2277
|
contentGuidelines: ['Use clear, descriptive page titles', 'Provide meaningful breadcrumb labels', 'Use action-oriented button text', 'Keep header content focused'],
|
|
@@ -2319,7 +2315,7 @@ var components = exports.components = [{
|
|
|
2319
2315
|
category: 'navigation',
|
|
2320
2316
|
description: 'A component for pagination controls.',
|
|
2321
2317
|
status: 'general-availability',
|
|
2322
|
-
examples: ["import Pagination from '@atlaskit/pagination';\
|
|
2318
|
+
examples: ["import Pagination from '@atlaskit/pagination';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<Pagination\n\t\t\tpages={[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]}\n\t\t\tdefaultSelectedIndex={2}\n\t\t\tmax={7}\n\t\t\tonChange={(_event, page) => console.log('Page selected:', page)}\n\t\t/>\n\t\t<Pagination\n\t\t\tpages={['A', 'B', 'C', 'D']}\n\t\t\tdefaultSelectedIndex={1}\n\t\t\tonChange={(_event, page) => console.log('Letter page:', page)}\n\t\t/>\n\t</>\n);\nexport default Examples;"],
|
|
2323
2319
|
accessibilityGuidelines: ['Provide clear page navigation labels', 'Use appropriate ARIA labels for pagination', 'Ensure keyboard navigation support', 'Announce page changes to screen readers'],
|
|
2324
2320
|
usageGuidelines: ['Use for navigating through paged content', 'Provide clear page indicators', 'Consider total page count display', 'Use appropriate page limits'],
|
|
2325
2321
|
contentGuidelines: ['Use clear page labels', 'Provide meaningful navigation text', 'Use consistent pagination terminology', 'Consider page context information'],
|
|
@@ -2383,7 +2379,7 @@ var components = exports.components = [{
|
|
|
2383
2379
|
category: 'utility',
|
|
2384
2380
|
description: 'A component for positioning elements relative to other elements.',
|
|
2385
2381
|
status: 'general-availability',
|
|
2386
|
-
examples: ['import { Manager, Popper, Reference } from \'@atlaskit/popper\';\nexport default () => (\n\t<Manager>\n\t\t<Reference>\n\t\t\t{({ ref }) => (\n\t\t\t\t<button ref={ref} type="button">\n\t\t\t\t\tReference element\n\t\t\t\t</button>\n\t\t\t)}\n\t\t</Reference>\n\t\t<Popper placement="right">\n\t\t\t{({ ref, style }) => (\n\t\t\t\t<div ref={ref} style={style} >\n\t\t\t\t\t↔ This text is a popper placed to the right\n\t\t\t\t</div>\n\t\t\t)}\n\t\t</Popper>\n\t</Manager>\n);'],
|
|
2382
|
+
examples: ['import { Manager, Popper, Reference } from \'@atlaskit/popper\';\nexport default (): React.JSX.Element => (\n\t<Manager>\n\t\t<Reference>\n\t\t\t{({ ref }) => (\n\t\t\t\t<button ref={ref} type="button">\n\t\t\t\t\tReference element\n\t\t\t\t</button>\n\t\t\t)}\n\t\t</Reference>\n\t\t<Popper placement="right">\n\t\t\t{({ ref, style }) => (\n\t\t\t\t<div ref={ref} style={style} >\n\t\t\t\t\t↔ This text is a popper placed to the right\n\t\t\t\t</div>\n\t\t\t)}\n\t\t</Popper>\n\t</Manager>\n);'],
|
|
2387
2383
|
accessibilityGuidelines: ['Ensure proper positioning and visibility', 'Consider screen reader accessibility', 'Use appropriate ARIA attributes', 'Handle focus management'],
|
|
2388
2384
|
usageGuidelines: ['Use for positioning overlays and tooltips', 'Consider positioning constraints', 'Handle responsive positioning', 'Use appropriate z-index management'],
|
|
2389
2385
|
contentGuidelines: ['Ensure positioned content is accessible', 'Use appropriate positioning strategies', 'Consider content visibility and readability'],
|
|
@@ -2423,7 +2419,7 @@ var components = exports.components = [{
|
|
|
2423
2419
|
category: 'overlay',
|
|
2424
2420
|
description: 'A component for displaying popup content relative to a trigger element.',
|
|
2425
2421
|
status: 'general-availability',
|
|
2426
|
-
examples: ["import React, { useState } from 'react';\nimport Button from '@atlaskit/button/new';\nimport Popup from '@atlaskit/popup';\nexport default () => {\n\tconst [isOpen, setIsOpen] = useState(false);\n\treturn (\n\t\t<Popup\n\t\t\tcontent={() => <div>Basic popup content</div>}\n\t\t\tisOpen={isOpen}\n\t\t\tonClose={() => setIsOpen(false)}\n\t\t\tplacement=\"bottom-start\"\n\t\t\ttrigger={(triggerProps) => (\n\t\t\t\t<Button {...triggerProps} onClick={() => setIsOpen(!isOpen)}>\n\t\t\t\t\tToggle Popup\n\t\t\t\t</Button>\n\t\t\t)}\n\t\t\tshouldRenderToParent\n\t\t/>\n\t);\n};"],
|
|
2422
|
+
examples: ["import React, { useState } from 'react';\nimport Button from '@atlaskit/button/new';\nimport Popup from '@atlaskit/popup';\nexport default (): React.JSX.Element => {\n\tconst [isOpen, setIsOpen] = useState(false);\n\treturn (\n\t\t<Popup\n\t\t\tcontent={() => <div>Basic popup content</div>}\n\t\t\tisOpen={isOpen}\n\t\t\tonClose={() => setIsOpen(false)}\n\t\t\tplacement=\"bottom-start\"\n\t\t\ttrigger={(triggerProps) => (\n\t\t\t\t<Button {...triggerProps} onClick={() => setIsOpen(!isOpen)}>\n\t\t\t\t\tToggle Popup\n\t\t\t\t</Button>\n\t\t\t)}\n\t\t\tshouldRenderToParent\n\t\t/>\n\t);\n};"],
|
|
2427
2423
|
accessibilityGuidelines: ['Provide appropriate focus management', 'Use clear trigger labels', 'Ensure keyboard navigation support', 'Provide escape key dismissal'],
|
|
2428
2424
|
usageGuidelines: ['Use for contextual content that appears on demand', 'Position appropriately relative to trigger', 'Consider dismissal behavior', 'Use appropriate content sizing'],
|
|
2429
2425
|
contentGuidelines: ['Keep popup content focused and relevant', 'Use clear, concise content', 'Provide appropriate actions when needed', 'Consider content hierarchy'],
|
|
@@ -2543,7 +2539,7 @@ var components = exports.components = [{
|
|
|
2543
2539
|
category: 'utility',
|
|
2544
2540
|
description: 'A component for rendering content outside the normal DOM hierarchy.',
|
|
2545
2541
|
status: 'general-availability',
|
|
2546
|
-
examples: ["import Portal from '@atlaskit/portal';\
|
|
2542
|
+
examples: ["import Portal from '@atlaskit/portal';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<Portal>\n\t\t\t<div>This content is rendered in a portal</div>\n\t\t</Portal>\n\t\t<Portal zIndex={1000}>\n\t\t\t<div>This content has a custom z-index</div>\n\t\t</Portal>\n\t</>\n);\nexport default Examples;"],
|
|
2547
2543
|
accessibilityGuidelines: ['Ensure proper focus management', 'Consider screen reader accessibility', 'Use appropriate ARIA attributes', 'Handle keyboard navigation'],
|
|
2548
2544
|
usageGuidelines: ['Use for rendering content outside normal DOM', 'Consider z-index and positioning', 'Handle focus management appropriately', 'Use for modals and overlays'],
|
|
2549
2545
|
contentGuidelines: ['Ensure portaled content is accessible', 'Consider content context and purpose', 'Use appropriate portal placement'],
|
|
@@ -2590,7 +2586,7 @@ var components = exports.components = [{
|
|
|
2590
2586
|
}, {
|
|
2591
2587
|
name: 'xcss',
|
|
2592
2588
|
description: 'Apply a subset of permitted styles powered by Atlassian Design System design tokens.',
|
|
2593
|
-
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "translate" | "content" | "color" | "grid" | "flex" | "fill" | "stroke" | "all" | "bottom" | "left" | "right" | "top" | ...
|
|
2589
|
+
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "translate" | "content" | "color" | "grid" | "flex" | "fill" | "stroke" | "all" | "bottom" | "left" | "right" | "top" | ... 485 more ... | "glyphOrientationVertical", DesignTokenStyles, ""> & ... 4 more ... & { ...; })'
|
|
2594
2590
|
}]
|
|
2595
2591
|
}, {
|
|
2596
2592
|
name: 'Bleed',
|
|
@@ -2625,7 +2621,7 @@ var components = exports.components = [{
|
|
|
2625
2621
|
}, {
|
|
2626
2622
|
name: 'xcss',
|
|
2627
2623
|
description: 'Apply a subset of permitted styles powered by Atlassian Design System design tokens.',
|
|
2628
|
-
type: 'false | (XCSSValue<"all" | "flex" | "grid" | "fill" | "stroke" | "bottom" | "left" | "right" | "top" | "clip" | "
|
|
2624
|
+
type: 'false | (XCSSValue<"all" | "flex" | "grid" | "fill" | "stroke" | "bottom" | "left" | "right" | "top" | "clip" | "overlay" | "accentColor" | "alignContent" | "alignItems" | "alignSelf" | ... 486 more ... | "glyphOrientationVertical", DesignTokenStyles, ""> & ... 4 more ... & { ...; })'
|
|
2629
2625
|
}]
|
|
2630
2626
|
}, {
|
|
2631
2627
|
name: 'Box',
|
|
@@ -2644,11 +2640,11 @@ var components = exports.components = [{
|
|
|
2644
2640
|
}, {
|
|
2645
2641
|
name: 'backgroundColor',
|
|
2646
2642
|
description: 'Token representing background color with a built-in fallback value.',
|
|
2647
|
-
type: '"utility.elevation.surface.current" | "elevation.surface" | "elevation.surface.overlay" | "elevation.surface.raised" | "elevation.surface.sunken" | "color.background.accent.lime.subtlest" | ...
|
|
2643
|
+
type: '"utility.elevation.surface.current" | "elevation.surface" | "elevation.surface.overlay" | "elevation.surface.raised" | "elevation.surface.sunken" | "color.background.accent.lime.subtlest" | ... 205 more ... | "elevation.surface.raised.pressed"'
|
|
2648
2644
|
}, {
|
|
2649
2645
|
name: 'xcss',
|
|
2650
2646
|
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.",
|
|
2651
|
-
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "height" | "width" | "translate" | "content" | "color" | "border" | "grid" | "page" | "all" | "backgroundColor" | "accentColor" | ...
|
|
2647
|
+
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "height" | "width" | "translate" | "content" | "color" | "border" | "grid" | "page" | "all" | "backgroundColor" | "accentColor" | ... 485 more ... | "glyphOrientationVertical", DesignTokenStyles, ""> & ... 4 more ... & { ...; })'
|
|
2652
2648
|
}]
|
|
2653
2649
|
}, {
|
|
2654
2650
|
name: 'Flex',
|
|
@@ -2703,7 +2699,7 @@ var components = exports.components = [{
|
|
|
2703
2699
|
}, {
|
|
2704
2700
|
name: 'xcss',
|
|
2705
2701
|
description: 'Apply a subset of permitted styles powered by Atlassian Design System design tokens.',
|
|
2706
|
-
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "alignItems" | "justifyContent" | "gap" | "columnGap" | "rowGap" | "direction" | "flex" | "grid" | "fill" | "stroke" | ...
|
|
2702
|
+
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "alignItems" | "justifyContent" | "gap" | "columnGap" | "rowGap" | "direction" | "flex" | "grid" | "fill" | "stroke" | ... 487 more ... | "glyphOrientationVertical", DesignTokenStyles, ""> & ... 4 more ... & { ...; })'
|
|
2707
2703
|
}]
|
|
2708
2704
|
}, {
|
|
2709
2705
|
name: 'Focusable',
|
|
@@ -2731,7 +2727,7 @@ var components = exports.components = [{
|
|
|
2731
2727
|
}, {
|
|
2732
2728
|
name: 'xcss',
|
|
2733
2729
|
description: 'Apply a subset of permitted styles powered by Atlassian Design System design tokens.',
|
|
2734
|
-
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "color" | "height" | "width" | "alignmentBaseline" | "baselineShift" | "clip" | "clipRule" | "colorInterpolation" | ...
|
|
2730
|
+
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "color" | "height" | "width" | "alignmentBaseline" | "baselineShift" | "clip" | "clipRule" | "colorInterpolation" | ... 489 more ... | "viewTimeline", DesignTokenStyles, ""> & ... 4 more ... & { ...; })'
|
|
2735
2731
|
}]
|
|
2736
2732
|
}, {
|
|
2737
2733
|
name: 'Grid',
|
|
@@ -2790,7 +2786,7 @@ var components = exports.components = [{
|
|
|
2790
2786
|
}, {
|
|
2791
2787
|
name: 'xcss',
|
|
2792
2788
|
description: 'Apply a subset of permitted styles powered by Atlassian Design System design tokens.',
|
|
2793
|
-
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "alignItems" | "alignContent" | "justifyContent" | "gap" | "columnGap" | "rowGap" | "flex" | "grid" | "fill" | "stroke" | ...
|
|
2789
|
+
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "alignItems" | "alignContent" | "justifyContent" | "gap" | "columnGap" | "rowGap" | "flex" | "grid" | "fill" | "stroke" | ... 487 more ... | "glyphOrientationVertical", DesignTokenStyles, ""> & ... 4 more ... & { ...; })'
|
|
2794
2790
|
}]
|
|
2795
2791
|
}, {
|
|
2796
2792
|
name: 'Inline',
|
|
@@ -2849,7 +2845,7 @@ var components = exports.components = [{
|
|
|
2849
2845
|
}, {
|
|
2850
2846
|
name: 'xcss',
|
|
2851
2847
|
description: 'Apply a subset of permitted styles powered by Atlassian Design System design tokens.',
|
|
2852
|
-
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "fill" | "gap" | "rowGap" | "flex" | "grid" | "stroke" | "all" | "bottom" | "left" | "right" | "top" | "clip" | "
|
|
2848
|
+
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "fill" | "gap" | "rowGap" | "flex" | "grid" | "stroke" | "all" | "bottom" | "left" | "right" | "top" | "clip" | "overlay" | ... 484 more ... | "glyphOrientationVertical", DesignTokenStyles, ""> & ... 4 more ... & { ...; })'
|
|
2853
2849
|
}]
|
|
2854
2850
|
}, {
|
|
2855
2851
|
name: 'MetricText',
|
|
@@ -2908,7 +2904,7 @@ var components = exports.components = [{
|
|
|
2908
2904
|
}, {
|
|
2909
2905
|
name: 'xcss',
|
|
2910
2906
|
description: 'Apply a subset of permitted styles powered by Atlassian Design System design tokens.',
|
|
2911
|
-
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "translate" | "content" | "color" | "grid" | "flex" | "fill" | "stroke" | "all" | "bottom" | "left" | "right" | "top" | ...
|
|
2907
|
+
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "translate" | "content" | "color" | "grid" | "flex" | "fill" | "stroke" | "all" | "bottom" | "left" | "right" | "top" | ... 485 more ... | "glyphOrientationVertical", DesignTokenStyles, ""> & ... 4 more ... & { ...; })'
|
|
2912
2908
|
}]
|
|
2913
2909
|
}, {
|
|
2914
2910
|
name: 'Stack',
|
|
@@ -2955,7 +2951,7 @@ var components = exports.components = [{
|
|
|
2955
2951
|
}, {
|
|
2956
2952
|
name: 'xcss',
|
|
2957
2953
|
description: 'Apply a subset of permitted styles powered by Atlassian Design System design tokens.',
|
|
2958
|
-
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "fill" | "gap" | "flex" | "grid" | "stroke" | "all" | "bottom" | "left" | "right" | "top" | "clip" | "
|
|
2954
|
+
type: 'false | (XCSSValue<"clipPath" | "filter" | "marker" | "mask" | "fill" | "gap" | "flex" | "grid" | "stroke" | "all" | "bottom" | "left" | "right" | "top" | "clip" | "overlay" | "accentColor" | ... 484 more ... | "glyphOrientationVertical", DesignTokenStyles, ""> & ... 4 more ... & { ...; })'
|
|
2959
2955
|
}]
|
|
2960
2956
|
}, {
|
|
2961
2957
|
name: 'Text',
|
|
@@ -3006,7 +3002,7 @@ var components = exports.components = [{
|
|
|
3006
3002
|
}, {
|
|
3007
3003
|
name: 'xcss',
|
|
3008
3004
|
description: 'Bounded style overrides.',
|
|
3009
|
-
type: 'false | (XCSSValue<"overflowWrap" | "textDecorationLine", DesignTokenStyles, ""> & {} & XCSSPseudo<"overflowWrap" | "textDecorationLine", never, never, DesignTokenStyles> & XCSSMediaQuery<...> & { ...; } & { ...; })'
|
|
3005
|
+
type: 'false | (XCSSValue<"fontVariantNumeric" | "overflowWrap" | "textDecorationLine", DesignTokenStyles, ""> & {} & XCSSPseudo<"fontVariantNumeric" | "overflowWrap" | "textDecorationLine", never, never, DesignTokenStyles> & XCSSMediaQuery<...> & { ...; } & { ...; })'
|
|
3010
3006
|
}]
|
|
3011
3007
|
}, {
|
|
3012
3008
|
name: 'ProgressBar',
|
|
@@ -3015,7 +3011,7 @@ var components = exports.components = [{
|
|
|
3015
3011
|
category: 'loading',
|
|
3016
3012
|
description: 'A progress bar communicates the status of a system process, showing completion percentage or indeterminate progress.',
|
|
3017
3013
|
status: 'general-availability',
|
|
3018
|
-
examples: ['import ProgressBar from \'@atlaskit/progress-bar\';\
|
|
3014
|
+
examples: ['import ProgressBar from \'@atlaskit/progress-bar\';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<ProgressBar value={0.5} />\n\t\t<ProgressBar value={0.8} appearance="success" />\n\t</>\n);\nexport default Examples;'],
|
|
3019
3015
|
accessibilityGuidelines: ['Provide appropriate ARIA labels for progress bars', 'Announce progress changes to screen readers', 'Use appropriate color contrast for visibility', 'Provide alternative text for progress status'],
|
|
3020
3016
|
usageGuidelines: ['Use for showing progress of known duration', 'Provide clear progress indicators', 'Use indeterminate state for unknown duration', 'Position progress bars prominently when active', 'Consider providing percentage or time estimates'],
|
|
3021
3017
|
contentGuidelines: ['Use clear, descriptive progress messages', 'Provide meaningful context for progress', 'Consider showing estimated time remaining', 'Use consistent progress terminology'],
|
|
@@ -3043,7 +3039,7 @@ var components = exports.components = [{
|
|
|
3043
3039
|
category: 'loading',
|
|
3044
3040
|
description: 'A progress bar variant that indicates successful completion of a process.',
|
|
3045
3041
|
status: 'general-availability',
|
|
3046
|
-
examples: ["import { SuccessProgressBar } from '@atlaskit/progress-bar';\
|
|
3042
|
+
examples: ["import { SuccessProgressBar } from '@atlaskit/progress-bar';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<SuccessProgressBar value={1.0} />\n\t\t<SuccessProgressBar value={0.9} />\n\t</>\n);\nexport default Examples;"],
|
|
3047
3043
|
usageGuidelines: ['Use to indicate successful completion', 'Show briefly before transitioning to next state', 'Use appropriate success styling', 'Consider providing success message'],
|
|
3048
3044
|
contentGuidelines: ['Use clear success messaging', 'Indicate what was completed successfully', 'Provide next steps if applicable'],
|
|
3049
3045
|
props: [{
|
|
@@ -3066,7 +3062,7 @@ var components = exports.components = [{
|
|
|
3066
3062
|
category: 'loading',
|
|
3067
3063
|
description: 'A progress bar variant with transparent background for overlay contexts.',
|
|
3068
3064
|
status: 'general-availability',
|
|
3069
|
-
examples: ["import { TransparentProgressBar } from '@atlaskit/progress-bar';\
|
|
3065
|
+
examples: ["import { TransparentProgressBar } from '@atlaskit/progress-bar';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<TransparentProgressBar value={0.6} />\n\t\t<TransparentProgressBar value={0.3} />\n\t</>\n);\nexport default Examples;"],
|
|
3070
3066
|
usageGuidelines: ['Use in overlay or modal contexts', 'Ensure sufficient contrast with background', 'Use for subtle progress indication', 'Consider backdrop visibility'],
|
|
3071
3067
|
contentGuidelines: ['Ensure progress is visible against background', 'Use appropriate contrast for readability', 'Keep progress indication clear'],
|
|
3072
3068
|
props: [{
|
|
@@ -3089,7 +3085,7 @@ var components = exports.components = [{
|
|
|
3089
3085
|
category: 'feedback',
|
|
3090
3086
|
description: 'A component for displaying progress through steps or completion status.',
|
|
3091
3087
|
status: 'general-availability',
|
|
3092
|
-
examples: ["import { ProgressIndicator } from '@atlaskit/progress-indicator';\
|
|
3088
|
+
examples: ["import { ProgressIndicator } from '@atlaskit/progress-indicator';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<ProgressIndicator selectedIndex={1} values={['Step 1', 'Step 2', 'Step 3']} />\n\t\t<ProgressIndicator selectedIndex={2} values={['Start', 'In Progress', 'Complete']} />\n\t</>\n);\nexport default Examples;"],
|
|
3093
3089
|
accessibilityGuidelines: ['Ensure progress is announced by screen readers', 'Use appropriate progress indicators', 'Provide clear progress context', 'Consider progress timing and updates'],
|
|
3094
3090
|
usageGuidelines: ['Use for step-by-step processes', 'Provide clear progress indicators', 'Handle progress updates appropriately', 'Consider progress completion states'],
|
|
3095
3091
|
contentGuidelines: ['Use clear, descriptive step labels', 'Provide meaningful progress descriptions', 'Use appropriate progress terminology', 'Keep progress information concise'],
|
|
@@ -3133,7 +3129,7 @@ var components = exports.components = [{
|
|
|
3133
3129
|
category: 'feedback',
|
|
3134
3130
|
description: 'A component for tracking progress through multi-step processes.',
|
|
3135
3131
|
status: 'general-availability',
|
|
3136
|
-
examples: ["import { ProgressTracker } from '@atlaskit/progress-tracker';\
|
|
3132
|
+
examples: ["import { ProgressTracker } from '@atlaskit/progress-tracker';\nconst Example = (): React.JSX.Element => (\n\t<ProgressTracker\n\t\titems={[\n\t\t\t{ id: 'step1', label: 'Step 1', status: 'visited', percentageComplete: 100 },\n\t\t\t{ id: 'step2', label: 'Step 2', status: 'current', percentageComplete: 40 },\n\t\t\t{ id: 'step3', label: 'Step 3', status: 'disabled', percentageComplete: 0 },\n\t\t\t{ id: 'step4', label: 'Step 4', status: 'unvisited', percentageComplete: 0 },\n\t\t]}\n\t/>\n);\nexport default Example;"],
|
|
3137
3133
|
accessibilityGuidelines: ['Ensure progress is announced by screen readers', 'Use appropriate progress indicators', 'Provide clear progress context', 'Consider progress timing and updates'],
|
|
3138
3134
|
usageGuidelines: ['Use for multi-step workflows', 'Provide clear progress tracking', 'Handle progress updates appropriately', 'Consider progress completion states'],
|
|
3139
3135
|
contentGuidelines: ['Use clear, descriptive step labels', 'Provide meaningful progress descriptions', 'Use appropriate progress terminology', 'Keep progress information concise'],
|
|
@@ -3161,7 +3157,7 @@ var components = exports.components = [{
|
|
|
3161
3157
|
category: 'form',
|
|
3162
3158
|
description: 'A radio button component for single selection from a set of mutually exclusive choices. Use for custom radio button presentations like options in tables or when you need fine control over individual radio buttons.',
|
|
3163
3159
|
status: 'general-availability',
|
|
3164
|
-
examples: ['import { Radio } from \'@atlaskit/radio\';\nexport default () => (\n\t<Radio value="option1" label="Option 1" name="choices" onChange={() => console.log(\'Changed!\')} />\n);'],
|
|
3160
|
+
examples: ['import { Radio } from \'@atlaskit/radio\';\nexport default (): React.JSX.Element => (\n\t<Radio value="option1" label="Option 1" name="choices" onChange={() => console.log(\'Changed!\')} />\n);'],
|
|
3165
3161
|
accessibilityGuidelines: ['Include error messages for required or invalid radio fields', 'Never preselect high-risk options for payment, privacy, or security', "Don't use disabled radio buttons if they need to remain in tab order", 'Use validation instead of disabled state for better accessibility'],
|
|
3166
3162
|
usageGuidelines: ['Use for custom radio button presentations (e.g., options in tables)', 'Use when you need fine control over individual radio buttons', 'List options in logical order (most likely to least likely)', 'Make one option the default (safest, most secure option)', "Add 'None' option if unselected state is needed", "Add 'Other' option if not all options can be listed"],
|
|
3167
3163
|
contentGuidelines: ['Use clear, descriptive labels that provide context', 'Keep labels concise but informative', 'Use sentence case for labels', 'Avoid alphabetical ordering (not localizable)', 'Avoid overlapping or skipping numeric choices'],
|
|
@@ -3209,7 +3205,7 @@ var components = exports.components = [{
|
|
|
3209
3205
|
category: 'form',
|
|
3210
3206
|
description: 'A radio group component that presents a list of options where only one choice can be selected. Use for most radio button scenarios where you want a simple list of mutually exclusive options.',
|
|
3211
3207
|
status: 'general-availability',
|
|
3212
|
-
examples: ["import { RadioGroup } from '@atlaskit/radio';\n// Radio group with options\nconst options = [\n\t{ name: 'color', value: 'red', label: 'Red' },\n\t{ name: 'color', value: 'blue', label: 'Blue' },\n];\nexport default () => {\n\tconst [value, setValue] = React.useState('red');\n\treturn (\n\t\t<RadioGroup options={options} value={value} onChange={(e) => setValue(e.currentTarget.value)} />\n\t);\n};"],
|
|
3208
|
+
examples: ["import { RadioGroup } from '@atlaskit/radio';\n// Radio group with options\nconst options = [\n\t{ name: 'color', value: 'red', label: 'Red' },\n\t{ name: 'color', value: 'blue', label: 'Blue' },\n];\nexport default (): React.JSX.Element => {\n\tconst [value, setValue] = React.useState('red');\n\treturn (\n\t\t<RadioGroup options={options} value={value} onChange={(e) => setValue(e.currentTarget.value)} />\n\t);\n};"],
|
|
3213
3209
|
accessibilityGuidelines: ['Include error messages for required or invalid radio fields', 'Never preselect high-risk options for payment, privacy, or security', "Don't use disabled radio buttons if they need to remain in tab order", 'Use validation instead of disabled state for better accessibility', 'Ensure proper keyboard navigation with arrow keys'],
|
|
3214
3210
|
usageGuidelines: ['Use for most radio button scenarios with simple option lists', 'List options in logical order (most likely to least likely)', 'Make one option the default (safest, most secure option)', "Add 'None' option if unselected state is needed", "Add 'Other' option if not all options can be listed", 'Use select component for longer lists of options'],
|
|
3215
3211
|
contentGuidelines: ['Use clear, descriptive labels that provide context', 'Keep labels concise but informative', 'Use sentence case for labels', 'Avoid alphabetical ordering (not localizable)', 'Avoid overlapping or skipping numeric choices'],
|
|
@@ -3265,7 +3261,7 @@ var components = exports.components = [{
|
|
|
3265
3261
|
category: 'form',
|
|
3266
3262
|
description: 'A component for selecting a value from a range of values.',
|
|
3267
3263
|
status: 'general-availability',
|
|
3268
|
-
examples: ["import Range from '@atlaskit/range';\
|
|
3264
|
+
examples: ["import Range from '@atlaskit/range';\nconst Example = (): React.JSX.Element => (\n\t<Range\n\t\tvalue={25}\n\t\tmin={0}\n\t\tmax={50}\n\t\tstep={5}\n\t\tonChange={(value) => console.log('Stepped value:', value)}\n\t/>\n);\nexport default Example;"],
|
|
3269
3265
|
accessibilityGuidelines: ['Provide clear labels for range inputs', 'Use appropriate ARIA attributes', 'Ensure keyboard navigation support', 'Provide value announcements for screen readers'],
|
|
3270
3266
|
usageGuidelines: ['Use for selecting numeric values within a range', 'Provide clear min/max boundaries', 'Use appropriate step increments', 'Consider showing current value'],
|
|
3271
3267
|
contentGuidelines: ['Use clear range labels', 'Provide meaningful min/max labels', 'Show current value when helpful', 'Use consistent range terminology'],
|
|
@@ -3345,7 +3341,7 @@ var components = exports.components = [{
|
|
|
3345
3341
|
category: 'form',
|
|
3346
3342
|
description: 'A flexible select component for single and multi-selection.',
|
|
3347
3343
|
status: 'general-availability',
|
|
3348
|
-
examples: ["import { Label } from '@atlaskit/form';\nimport Select from '@atlaskit/select';\nexport default function SelectAppearanceDefault() {\n\treturn (\n\t\t<>\n\t\t\t<Label htmlFor=\"default-appearance-example\">Favorite fruit</Label>\n\t\t\t<Select\n\t\t\t\tinputId=\"default-appearance-example\"\n\t\t\t\tappearance=\"default\"\n\t\t\t\toptions={[\n\t\t\t\t\t{ label: 'Apple', value: 'a' },\n\t\t\t\t\t{ label: 'Banana', value: 'b' },\n\t\t\t\t]}\n\t\t\t/>\n\t\t</>\n\t);\n}"],
|
|
3344
|
+
examples: ["import { Label } from '@atlaskit/form';\nimport Select from '@atlaskit/select';\nexport default function SelectAppearanceDefault(): React.JSX.Element {\n\treturn (\n\t\t<>\n\t\t\t<Label htmlFor=\"default-appearance-example\">Favorite fruit</Label>\n\t\t\t<Select\n\t\t\t\tinputId=\"default-appearance-example\"\n\t\t\t\tappearance=\"default\"\n\t\t\t\toptions={[\n\t\t\t\t\t{ label: 'Apple', value: 'a' },\n\t\t\t\t\t{ label: 'Banana', value: 'b' },\n\t\t\t\t]}\n\t\t\t/>\n\t\t</>\n\t);\n}"],
|
|
3349
3345
|
accessibilityGuidelines: ['Provide clear labels for all selects', 'Use appropriate placeholder text', 'Ensure keyboard navigation with arrow keys', 'Provide clear option descriptions', 'Support screen reader announcements'],
|
|
3350
3346
|
usageGuidelines: ['Use for choosing from a list of options', 'Use multi-select for multiple choice scenarios', 'Enable search for long option lists', 'Provide clear placeholder text', 'Consider loading states for async data'],
|
|
3351
3347
|
contentGuidelines: ['Write clear, descriptive option labels', 'Use consistent terminology across options', 'Keep option text concise but meaningful', 'Group related options logically'],
|
|
@@ -3713,7 +3709,7 @@ var components = exports.components = [{
|
|
|
3713
3709
|
category: 'navigation',
|
|
3714
3710
|
description: 'Tabs are used to organize content by grouping similar information on the same page.',
|
|
3715
3711
|
status: 'general-availability',
|
|
3716
|
-
examples: ['import Tabs, { Tab, TabList, TabPanel } from \'@atlaskit/tabs\';\
|
|
3712
|
+
examples: ['import Tabs, { Tab, TabList, TabPanel } from \'@atlaskit/tabs\';\nconst Example = (): React.JSX.Element => (\n\t<Tabs id="tabs">\n\t\t<TabList>\n\t\t\t<Tab>Tab 1</Tab>\n\t\t\t<Tab>Tab 2</Tab>\n\t\t</TabList>\n\t\t<TabPanel>Content for Tab 1</TabPanel>\n\t\t<TabPanel>Content for Tab 2</TabPanel>\n\t</Tabs>\n);\nexport default Example;'],
|
|
3717
3713
|
accessibilityGuidelines: ['Ensure proper keyboard navigation between tabs', 'Use appropriate ARIA attributes for tab panels', 'Provide clear focus indicators', 'Announce tab changes to screen readers', 'Ensure tab content is accessible'],
|
|
3718
3714
|
usageGuidelines: ['Use to organize related content on the same page', 'Keep tab labels concise and descriptive', 'Limit the number of tabs to avoid overcrowding', 'Use consistent tab ordering and grouping', 'Consider responsive behavior for many tabs'],
|
|
3719
3715
|
contentGuidelines: ['Write clear, descriptive tab labels', 'Group related content logically', 'Use consistent naming conventions', 'Ensure tab content is relevant and complete'],
|
|
@@ -3749,7 +3745,7 @@ var components = exports.components = [{
|
|
|
3749
3745
|
category: 'data-display',
|
|
3750
3746
|
description: 'A tag is a compact element used to categorize, label, or organize content.',
|
|
3751
3747
|
status: 'general-availability',
|
|
3752
|
-
examples: ['import Tag from \'@atlaskit/tag\';\
|
|
3748
|
+
examples: ['import Tag from \'@atlaskit/tag\';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<Tag text="Basic tag" />\n\t\t<Tag text="Bug" color="red" />\n\t\t<Tag text="Removable tag" removeButtonLabel="Remove" />\n\t</>\n);\nexport default Examples;'],
|
|
3753
3749
|
accessibilityGuidelines: ['Provide appropriate labels for tags', 'Ensure sufficient color contrast for text readability', 'Use clear, descriptive tag text', 'Consider keyboard navigation for interactive tags', 'Provide alternative text for tag removal actions'],
|
|
3754
3750
|
usageGuidelines: ['Use to categorize or label content', 'Keep tag text concise and meaningful', 'Use appropriate colors and appearances', 'Consider tag removal functionality', 'Group related tags logically'],
|
|
3755
3751
|
contentGuidelines: ['Use clear, descriptive tag labels', 'Keep tag text concise', 'Use consistent terminology across tags', 'Consider tag hierarchy and grouping'],
|
|
@@ -3760,7 +3756,7 @@ var components = exports.components = [{
|
|
|
3760
3756
|
}, {
|
|
3761
3757
|
name: 'color',
|
|
3762
3758
|
description: 'The color theme to apply. This sets both the background and text color.',
|
|
3763
|
-
type: '"standard" | "green" | "lime" | "blue" | "red" | "purple" | "magenta" | "grey" | "teal" | "orange" | "yellow" | "limeLight" | "orangeLight" | "magentaLight" | "greenLight" |
|
|
3759
|
+
type: '"standard" | "green" | "lime" | "blue" | "red" | "purple" | "magenta" | "grey" | "gray" | "teal" | "orange" | "yellow" | "limeLight" | "orangeLight" | "magentaLight" | "greenLight" | ... 5 more ... | "yellowLight"'
|
|
3764
3760
|
}, {
|
|
3765
3761
|
name: 'elemBefore',
|
|
3766
3762
|
description: 'The component to be rendered before the tag.',
|
|
@@ -3801,7 +3797,7 @@ var components = exports.components = [{
|
|
|
3801
3797
|
category: 'data-display',
|
|
3802
3798
|
description: 'A component for managing multiple tags.',
|
|
3803
3799
|
status: 'general-availability',
|
|
3804
|
-
examples: ['import Tag from \'@atlaskit/tag\';\nimport TagGroup from \'@atlaskit/tag-group\';\
|
|
3800
|
+
examples: ['import Tag from \'@atlaskit/tag\';\nimport TagGroup from \'@atlaskit/tag-group\';\nconst Example = (): React.JSX.Element => (\n\t<TagGroup label="Tags for work item">\n\t\t<Tag text="Priority: High" color="red" />\n\t\t<Tag text="Status: Active" color="green" />\n\t\t<Tag text="Type: Bug" color="blue" />\n\t</TagGroup>\n);\nexport default Example;'],
|
|
3805
3801
|
accessibilityGuidelines: ['Provide clear tag labels', 'Ensure proper keyboard navigation', 'Use appropriate grouping semantics', 'Consider screen reader announcements'],
|
|
3806
3802
|
usageGuidelines: ['Use for grouping related tags', 'Consider tag alignment and spacing', 'Use for categorizing content', 'Provide clear tag relationships'],
|
|
3807
3803
|
contentGuidelines: ['Use consistent tag naming', 'Keep tag text concise', 'Use meaningful tag categories', 'Consider tag hierarchy'],
|
|
@@ -3829,7 +3825,7 @@ var components = exports.components = [{
|
|
|
3829
3825
|
category: 'forms-and-input',
|
|
3830
3826
|
description: 'A textarea is a multiline text input control for longer text content.',
|
|
3831
3827
|
status: 'general-availability',
|
|
3832
|
-
examples: ['import Textarea from \'@atlaskit/textarea\';\
|
|
3828
|
+
examples: ['import Textarea from \'@atlaskit/textarea\';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<Textarea placeholder="Enter your text..." />\n\t\t<Textarea placeholder="Required field" isRequired resize="auto" name="comments" />\n\t</>\n);\nexport default Examples;'],
|
|
3833
3829
|
accessibilityGuidelines: ['Provide clear labels for all textareas', "Use appropriate placeholder text that doesn't replace labels", 'Provide keyboard navigation support', 'Indicate required fields clearly', 'Use appropriate error states and messaging'],
|
|
3834
3830
|
usageGuidelines: ['Use for longer text input needs', 'Provide appropriate sizing for content type', 'Use clear, descriptive labels', 'Consider character limits and validation', 'Use appropriate placeholder text'],
|
|
3835
3831
|
contentGuidelines: ['Write clear, descriptive labels', 'Use helpful placeholder text', 'Provide appropriate error messages', 'Consider content length and formatting'],
|
|
@@ -3917,7 +3913,7 @@ var components = exports.components = [{
|
|
|
3917
3913
|
category: 'form',
|
|
3918
3914
|
description: 'A single-line text input component.',
|
|
3919
3915
|
status: 'general-availability',
|
|
3920
|
-
examples: ['import TextField from \'@atlaskit/textfield\';\
|
|
3916
|
+
examples: ['import TextField from \'@atlaskit/textfield\';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<TextField label="Name" placeholder="Enter your name" />\n\t\t<TextField label="Email" type="email" placeholder="Enter your email address" isRequired />\n\t\t<TextField label="Password" type="password" placeholder="Enter your password" isRequired />\n\t</>\n);\nexport default Examples;'],
|
|
3921
3917
|
accessibilityGuidelines: ['Provide clear labels for all textfields', "Use appropriate placeholder text that doesn't replace labels", 'Provide keyboard navigation support', 'Indicate required fields clearly', 'Use appropriate error states and messaging'],
|
|
3922
3918
|
usageGuidelines: ['Use for single-line text input needs', 'Provide appropriate sizing for content type', 'Use clear, descriptive labels', 'Consider character limits and validation', 'Use appropriate placeholder text'],
|
|
3923
3919
|
contentGuidelines: ['Write clear, descriptive labels', 'Use helpful placeholder text', 'Provide appropriate error messages', 'Consider content length and formatting'],
|
|
@@ -3985,7 +3981,7 @@ var components = exports.components = [{
|
|
|
3985
3981
|
category: 'forms-and-input',
|
|
3986
3982
|
description: 'A toggle is used to view or switch between enabled or disabled states.',
|
|
3987
3983
|
status: 'general-availability',
|
|
3988
|
-
examples: ['import Toggle from \'@atlaskit/toggle\';\
|
|
3984
|
+
examples: ['import Toggle from \'@atlaskit/toggle\';\nconst Examples = (): React.JSX.Element => (\n\t<>\n\t\t<Toggle label="Basic toggle" />\n\t\t<Toggle label="Checked toggle" isChecked />\n\t</>\n);\nexport default Examples;'],
|
|
3989
3985
|
accessibilityGuidelines: ['Provide clear labels for all toggles', 'Use appropriate ARIA attributes for toggle state', 'Ensure keyboard navigation support', 'Provide clear visual feedback for state changes', "Use descriptive labels that explain the toggle's purpose"],
|
|
3990
3986
|
usageGuidelines: ['Use for binary on/off states', "Provide clear labels that describe the toggle's function", 'Use appropriate default states', 'Consider immediate vs. delayed state changes', 'Use consistent toggle behavior across the interface'],
|
|
3991
3987
|
contentGuidelines: ['Write clear, descriptive labels', 'Use action-oriented language when appropriate', 'Ensure labels clearly indicate what the toggle controls', 'Use consistent terminology across toggles'],
|
|
@@ -4049,7 +4045,7 @@ var components = exports.components = [{
|
|
|
4049
4045
|
category: 'overlays-and-layering',
|
|
4050
4046
|
description: 'A tooltip is a floating, non-actionable label used to explain a user interface element or feature.',
|
|
4051
4047
|
status: 'general-availability',
|
|
4052
|
-
examples: ['import Button from \'@atlaskit/button/new\';\nimport Tooltip from \'@atlaskit/tooltip\';\nexport default function DefaultTooltipExample() {\n\treturn (\n\t\t<Tooltip content="This is a tooltip" testId="default-tooltip">\n\t\t\t{(tooltipProps) => <Button {...tooltipProps}>Hover over me</Button>}\n\t\t</Tooltip>\n\t);\n}'],
|
|
4048
|
+
examples: ['import Button from \'@atlaskit/button/new\';\nimport Tooltip from \'@atlaskit/tooltip\';\nexport default function DefaultTooltipExample(): React.JSX.Element {\n\treturn (\n\t\t<Tooltip content="This is a tooltip" testId="default-tooltip">\n\t\t\t{(tooltipProps) => <Button {...tooltipProps}>Hover over me</Button>}\n\t\t</Tooltip>\n\t);\n}'],
|
|
4053
4049
|
accessibilityGuidelines: ['Ensure tooltip content is announced by screen readers', 'Use appropriate hover/focus triggers', 'Provide keyboard access to tooltip content', 'Use clear, descriptive tooltip text', 'Consider tooltip timing and persistence'],
|
|
4054
4050
|
usageGuidelines: ['Use to provide additional context or explanation', 'Keep tooltip content concise and helpful', 'Position tooltips appropriately to avoid obstruction', 'Use consistent tooltip behavior across the interface', 'Consider mobile touch interactions'],
|
|
4055
4051
|
contentGuidelines: ['Write clear, concise explanatory text', 'Use helpful, actionable information', 'Avoid redundant information already visible', 'Use consistent tone and style'],
|
|
@@ -4125,7 +4121,7 @@ var components = exports.components = [{
|
|
|
4125
4121
|
category: 'utility',
|
|
4126
4122
|
description: 'A utility component for accessibility.',
|
|
4127
4123
|
status: 'general-availability',
|
|
4128
|
-
examples: ["import VisuallyHidden from '@atlaskit/visually-hidden';\nexport default () => {\n\treturn (\n\t\t<div style={{ border: '1px solid black' }}>\n\t\t\tThere is text hidden between the brackets [<VisuallyHidden>Can't see me!</VisuallyHidden>]\n\t\t</div>\n\t);\n};"],
|
|
4124
|
+
examples: ["import VisuallyHidden from '@atlaskit/visually-hidden';\nexport default (): React.JSX.Element => {\n\treturn (\n\t\t<div style={{ border: '1px solid black' }}>\n\t\t\tThere is text hidden between the brackets [<VisuallyHidden>Can't see me!</VisuallyHidden>]\n\t\t</div>\n\t);\n};"],
|
|
4129
4125
|
accessibilityGuidelines: ['Use for screen reader only content', 'Ensure content is meaningful for assistive technology', 'Use appropriate ARIA roles when needed', 'Consider content context and purpose'],
|
|
4130
4126
|
usageGuidelines: ['Use for screen reader only content', 'Provide meaningful hidden content', 'Use for accessibility enhancements', 'Consider content context and purpose'],
|
|
4131
4127
|
contentGuidelines: ['Use clear, descriptive hidden content', 'Ensure content adds value for screen readers', 'Use appropriate language and tone', 'Keep content concise but meaningful'],
|