@tmorrow/cre8-wc 1.1.3 → 1.1.6
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/lib/components/card/card.styles.d.ts.map +1 -1
- package/lib/components/card/card.styles.js +338 -1
- package/lib/components/card/card.styles.js.map +1 -1
- package/lib/components/field/field.styles.d.ts.map +1 -1
- package/lib/components/field/field.styles.js +359 -1
- package/lib/components/field/field.styles.js.map +1 -1
- package/lib/components/inline-alert/inline-alert.styles.d.ts.map +1 -1
- package/lib/components/inline-alert/inline-alert.styles.js +392 -1
- package/lib/components/inline-alert/inline-alert.styles.js.map +1 -1
- package/lib/design-tokens/brands/blue/css/fonts.css +31 -0
- package/lib/design-tokens/{brands copy/blue/css/tokens_blue.module.js → brands/blue/css/tokens_blue.css} +2 -7
- package/lib/design-tokens/brands/blue/css/tokens_brand.css +492 -0
- package/lib/design-tokens/brands/cre8/css/fonts.css +35 -0
- package/lib/design-tokens/brands/cre8/css/tokens_brand.css +494 -0
- package/lib/design-tokens/brands/cre8/css/tokens_cre8.css +767 -0
- package/lib/design-tokens/brands/cre8-a2ui/css/fonts.css +35 -0
- package/lib/design-tokens/brands/cre8-a2ui/css/tokens_brand.css +496 -0
- package/lib/design-tokens/brands/cre8-a2ui/css/tokens_cre8-a2ui.css +248 -0
- package/lib/design-tokens/brands/cre8-a2ui/css/tokens_cre8-a2ui.module.d.ts +1 -1
- package/lib/design-tokens/brands/cre8-a2ui/css/tokens_cre8-a2ui.module.d.ts.map +1 -1
- package/lib/design-tokens/brands/cre8-a2ui/css/tokens_cre8-a2ui.module.js +7 -3
- package/lib/design-tokens/brands/cre8-a2ui/css/tokens_cre8-a2ui.module.js.map +1 -1
- package/lib/design-tokens/brands/cre8-legacy/css/fonts.css +47 -0
- package/lib/design-tokens/brands/cre8-legacy/css/tokens_brand.css +464 -0
- package/lib/design-tokens/brands/cre8-legacy/css/tokens_cre8-legacy.css +0 -0
- package/lib/design-tokens/brands/femmecubator/css/fonts.css +35 -0
- package/lib/design-tokens/brands/legacy/css/fonts.css +26 -0
- package/lib/design-tokens/brands/legacy/css/tokens_brand.css +491 -0
- package/lib/design-tokens/brands/legacy/css/tokens_legacy.css +250 -0
- package/lib/design-tokens/brands/marketing/css/fonts.css +31 -0
- package/lib/design-tokens/brands/marketing/css/tokens_brand.css +502 -0
- package/lib/design-tokens/brands/minimalist/css/fonts.css +26 -0
- package/lib/design-tokens/brands/minimalist/css/tokens_brand.css +492 -0
- package/lib/design-tokens/brands/minimalist/css/tokens_minimalist.css +736 -0
- package/lib/design-tokens/brands/prisma/figma-tokens.css +339 -0
- package/lib/design-tokens/brands/starbucks/fonts.css +26 -0
- package/lib/design-tokens/brands/tmorrow/css/tokens_brand.css +104 -0
- package/lib/design-tokens/brands/tmorrow/css/tokens_tmorrow-frost.css +222 -0
- package/lib/design-tokens/brands/tmorrow/css/tokens_tmorrow-neon.css +218 -0
- package/lib/design-tokens/capitalone/fonts.css +26 -0
- package/lib/design-tokens/capitalone/overrides.css +33 -0
- package/lib/design-tokens/capitalone/tokens.module.css +532 -0
- package/lib/design-tokens/core/scss/abstracts/functions.css +0 -0
- package/lib/design-tokens/core/scss/theming/animation.css +1 -0
- package/lib/design-tokens/core/scss/theming/body.css +1 -0
- package/lib/design-tokens/core/scss/theming/breakpoints.css +0 -0
- package/lib/design-tokens/core/scss/theming/component.css +1 -0
- package/lib/design-tokens/core/scss/theming/component.scss +1 -1
- package/lib/design-tokens/core/scss/theming/display.css +1 -0
- package/lib/design-tokens/core/scss/theming/head.css +1 -0
- package/lib/design-tokens/core/scss/theming/spacing.css +1 -0
- package/lib/design-tokens/core/scss/theming/typography-usage.css +0 -0
- package/lib/design-tokens/core/scss/theming/variables.css +39 -0
- package/lib/design-tokens/core/scss/theming/variables.scss +3 -1
- package/lib/design-tokens/core/scss/theming/visibility.css +1 -0
- package/lib/design-tokens/core/scss/utilities/animation.css +1 -0
- package/lib/design-tokens/core/scss/utilities/colors.css +1 -0
- package/lib/design-tokens/core/scss/utilities/display.css +1 -0
- package/lib/design-tokens/femmecubator/equity.css +142 -0
- package/lib/design-tokens/femmecubator/fonts.css +35 -0
- package/lib/design-tokens/femmecubator/tokens_brand.css +146 -0
- package/lib/design-tokens/femmecubator/tokens_femmecubator.module.css +247 -0
- package/lib/design-tokens/figma-tokens.css +0 -0
- package/lib/design-tokens/mcdonalds/tokens.module.css +58 -0
- package/lib/design-tokens/target/fonts.css +26 -0
- package/lib/design-tokens/target/tokens.module.css +738 -0
- package/lib/scripts/generate-mcp-manifest.d.ts +8 -0
- package/lib/scripts/generate-mcp-manifest.d.ts.map +1 -0
- package/lib/scripts/generate-mcp-manifest.js +350 -0
- package/lib/scripts/generate-mcp-manifest.js.map +1 -0
- package/lib/vite.config.js +1 -1
- package/lib/vite.config.js.map +1 -1
- package/mcp-manifest.json +3844 -0
- package/package.json +7 -3
- package/lib/design-tokens/brands copy/blue/_base.scss +0 -142
- package/lib/design-tokens/brands copy/blue/badge.scss +0 -5
- package/lib/design-tokens/brands copy/blue/bg.scss +0 -35
- package/lib/design-tokens/brands copy/blue/border-style.scss +0 -5
- package/lib/design-tokens/brands copy/blue/border.scss +0 -21
- package/lib/design-tokens/brands copy/blue/borderRadius.scss +0 -15
- package/lib/design-tokens/brands copy/blue/borderWidth.scss +0 -11
- package/lib/design-tokens/brands copy/blue/breakpoint.scss +0 -9
- package/lib/design-tokens/brands copy/blue/button.scss +0 -225
- package/lib/design-tokens/brands copy/blue/content.scss +0 -29
- package/lib/design-tokens/brands copy/blue/css/tokens_blue.module.d.ts +0 -3
- package/lib/design-tokens/brands copy/blue/css/tokens_blue.module.d.ts.map +0 -1
- package/lib/design-tokens/brands copy/blue/css/tokens_blue.module.js.map +0 -1
- package/lib/design-tokens/brands copy/blue/desktop-menu.scss +0 -5
- package/lib/design-tokens/brands copy/blue/fontFamilies.scss +0 -5
- package/lib/design-tokens/brands copy/blue/fontSize.scss +0 -17
- package/lib/design-tokens/brands copy/blue/fontWeights.scss +0 -7
- package/lib/design-tokens/brands copy/blue/footer.scss +0 -9
- package/lib/design-tokens/brands copy/blue/header.scss +0 -81
- package/lib/design-tokens/brands copy/blue/icon-size.scss +0 -6
- package/lib/design-tokens/brands copy/blue/letterSpacing.scss +0 -9
- package/lib/design-tokens/brands copy/blue/lineHeights.scss +0 -15
- package/lib/design-tokens/brands copy/blue/link.scss +0 -4
- package/lib/design-tokens/brands copy/blue/paragraphIndent.scss +0 -4
- package/lib/design-tokens/brands copy/blue/paragraphSpacing.scss +0 -4
- package/lib/design-tokens/brands copy/blue/progress-meter.scss +0 -4
- package/lib/design-tokens/brands copy/blue/shadow.scss +0 -8
- package/lib/design-tokens/brands copy/blue/spacing.scss +0 -21
- package/lib/design-tokens/brands copy/blue/textCase.scss +0 -5
- package/lib/design-tokens/brands copy/blue/textDecoration.scss +0 -5
- package/lib/design-tokens/brands copy/blue/tokens-all-blue.scss +0 -628
- package/lib/design-tokens/brands copy/blue/tokens-brand.scss +0 -31
- package/lib/design-tokens/brands copy/blue-v1/_base.scss +0 -76
- package/lib/design-tokens/brands copy/blue-v1/badge.scss +0 -5
- package/lib/design-tokens/brands copy/blue-v1/bg.scss +0 -34
- package/lib/design-tokens/brands copy/blue-v1/border-style.scss +0 -5
- package/lib/design-tokens/brands copy/blue-v1/border.scss +0 -21
- package/lib/design-tokens/brands copy/blue-v1/borderRadius.scss +0 -15
- package/lib/design-tokens/brands copy/blue-v1/borderWidth.scss +0 -11
- package/lib/design-tokens/brands copy/blue-v1/breakpoint.scss +0 -9
- package/lib/design-tokens/brands copy/blue-v1/button.scss +0 -199
- package/lib/design-tokens/brands copy/blue-v1/content.scss +0 -29
- package/lib/design-tokens/brands copy/blue-v1/desktop-menu.scss +0 -5
- package/lib/design-tokens/brands copy/blue-v1/fontFamilies.scss +0 -5
- package/lib/design-tokens/brands copy/blue-v1/fontSize.scss +0 -17
- package/lib/design-tokens/brands copy/blue-v1/fontWeights.scss +0 -9
- package/lib/design-tokens/brands copy/blue-v1/footer.scss +0 -9
- package/lib/design-tokens/brands copy/blue-v1/header.scss +0 -79
- package/lib/design-tokens/brands copy/blue-v1/icon-size.scss +0 -6
- package/lib/design-tokens/brands copy/blue-v1/letterSpacing.scss +0 -9
- package/lib/design-tokens/brands copy/blue-v1/lineHeights.scss +0 -15
- package/lib/design-tokens/brands copy/blue-v1/link.scss +0 -4
- package/lib/design-tokens/brands copy/blue-v1/paragraphIndent.scss +0 -4
- package/lib/design-tokens/brands copy/blue-v1/paragraphSpacing.scss +0 -4
- package/lib/design-tokens/brands copy/blue-v1/shadow.scss +0 -8
- package/lib/design-tokens/brands copy/blue-v1/spacing.scss +0 -21
- package/lib/design-tokens/brands copy/blue-v1/textCase.scss +0 -5
- package/lib/design-tokens/brands copy/blue-v1/textDecoration.scss +0 -5
- package/lib/design-tokens/brands copy/blue-v1/tokens-all-blue-v1.scss +0 -534
- package/lib/design-tokens/brands copy/blue-v1/tokens-brand.scss +0 -30
- package/lib/design-tokens/brands copy/cre8/_base.scss +0 -157
- package/lib/design-tokens/brands copy/cre8/badge.scss +0 -5
- package/lib/design-tokens/brands copy/cre8/bg.scss +0 -34
- package/lib/design-tokens/brands copy/cre8/border-style.scss +0 -5
- package/lib/design-tokens/brands copy/cre8/border.scss +0 -18
- package/lib/design-tokens/brands copy/cre8/borderRadius.scss +0 -15
- package/lib/design-tokens/brands copy/cre8/borderWidth.scss +0 -11
- package/lib/design-tokens/brands copy/cre8/breakpoint.scss +0 -9
- package/lib/design-tokens/brands copy/cre8/button.scss +0 -211
- package/lib/design-tokens/brands copy/cre8/content.scss +0 -29
- package/lib/design-tokens/brands copy/cre8/desktop-menu.scss +0 -5
- package/lib/design-tokens/brands copy/cre8/fontFamilies.scss +0 -4
- package/lib/design-tokens/brands copy/cre8/fontSize.scss +0 -17
- package/lib/design-tokens/brands copy/cre8/fontWeights.scss +0 -7
- package/lib/design-tokens/brands copy/cre8/footer.scss +0 -8
- package/lib/design-tokens/brands copy/cre8/header.scss +0 -81
- package/lib/design-tokens/brands copy/cre8/icon-size.scss +0 -6
- package/lib/design-tokens/brands copy/cre8/letterSpacing.scss +0 -10
- package/lib/design-tokens/brands copy/cre8/lineHeights.scss +0 -22
- package/lib/design-tokens/brands copy/cre8/link.scss +0 -4
- package/lib/design-tokens/brands copy/cre8/paragraphIndent.scss +0 -4
- package/lib/design-tokens/brands copy/cre8/paragraphSpacing.scss +0 -4
- package/lib/design-tokens/brands copy/cre8/progress-meter.scss +0 -4
- package/lib/design-tokens/brands copy/cre8/shadow.scss +0 -8
- package/lib/design-tokens/brands copy/cre8/spacing.scss +0 -21
- package/lib/design-tokens/brands copy/cre8/textCase.scss +0 -5
- package/lib/design-tokens/brands copy/cre8/textDecoration.scss +0 -5
- package/lib/design-tokens/brands copy/cre8/tokens-all-cre8.scss +0 -631
- package/lib/design-tokens/brands copy/cre8/tokens-brand.scss +0 -31
- package/lib/design-tokens/brands copy/femmecubator/base.scss +0 -64
- package/lib/design-tokens/brands copy/femmecubator/border.scss +0 -15
- package/lib/design-tokens/brands copy/femmecubator/color.scss +0 -56
- package/lib/design-tokens/brands copy/femmecubator/spacing.scss +0 -13
- package/lib/design-tokens/brands copy/femmecubator/tokens-all-femmecubator.scss +0 -139
- package/lib/design-tokens/brands copy/femmecubator/tokens-brand.scss +0 -8
- package/lib/design-tokens/brands copy/legacy/_base.scss +0 -103
- package/lib/design-tokens/brands copy/legacy/badge.scss +0 -5
- package/lib/design-tokens/brands copy/legacy/bg.scss +0 -34
- package/lib/design-tokens/brands copy/legacy/border-style.scss +0 -5
- package/lib/design-tokens/brands copy/legacy/border.scss +0 -17
- package/lib/design-tokens/brands copy/legacy/borderRadius.scss +0 -15
- package/lib/design-tokens/brands copy/legacy/borderWidth.scss +0 -11
- package/lib/design-tokens/brands copy/legacy/breakpoint.scss +0 -9
- package/lib/design-tokens/brands copy/legacy/button.scss +0 -225
- package/lib/design-tokens/brands copy/legacy/content.scss +0 -29
- package/lib/design-tokens/brands copy/legacy/desktop-menu.scss +0 -5
- package/lib/design-tokens/brands copy/legacy/fontFamilies.scss +0 -4
- package/lib/design-tokens/brands copy/legacy/fontSize.scss +0 -17
- package/lib/design-tokens/brands copy/legacy/fontWeights.scss +0 -10
- package/lib/design-tokens/brands copy/legacy/footer.scss +0 -9
- package/lib/design-tokens/brands copy/legacy/header.scss +0 -81
- package/lib/design-tokens/brands copy/legacy/icon-size.scss +0 -6
- package/lib/design-tokens/brands copy/legacy/letterSpacing.scss +0 -9
- package/lib/design-tokens/brands copy/legacy/lineHeights.scss +0 -19
- package/lib/design-tokens/brands copy/legacy/paragraphIndent.scss +0 -4
- package/lib/design-tokens/brands copy/legacy/paragraphSpacing.scss +0 -4
- package/lib/design-tokens/brands copy/legacy/progress-meter.scss +0 -4
- package/lib/design-tokens/brands copy/legacy/shadow.scss +0 -8
- package/lib/design-tokens/brands copy/legacy/spacing.scss +0 -20
- package/lib/design-tokens/brands copy/legacy/textCase.scss +0 -5
- package/lib/design-tokens/brands copy/legacy/textDecoration.scss +0 -5
- package/lib/design-tokens/brands copy/legacy/tokens-all-legacy.scss +0 -588
- package/lib/design-tokens/brands copy/legacy/tokens-brand.scss +0 -30
- package/lib/design-tokens/brands copy/marketing/_base.scss +0 -137
- package/lib/design-tokens/brands copy/marketing/asset.scss +0 -7
- package/lib/design-tokens/brands copy/marketing/badge.scss +0 -5
- package/lib/design-tokens/brands copy/marketing/bg.scss +0 -35
- package/lib/design-tokens/brands copy/marketing/border-style.scss +0 -5
- package/lib/design-tokens/brands copy/marketing/border.scss +0 -21
- package/lib/design-tokens/brands copy/marketing/borderRadius.scss +0 -15
- package/lib/design-tokens/brands copy/marketing/borderWidth.scss +0 -11
- package/lib/design-tokens/brands copy/marketing/breakpoint.scss +0 -9
- package/lib/design-tokens/brands copy/marketing/button.scss +0 -225
- package/lib/design-tokens/brands copy/marketing/content.scss +0 -29
- package/lib/design-tokens/brands copy/marketing/desktop-menu.scss +0 -5
- package/lib/design-tokens/brands copy/marketing/fontFamilies.scss +0 -4
- package/lib/design-tokens/brands copy/marketing/fontSize.scss +0 -17
- package/lib/design-tokens/brands copy/marketing/fontWeights.scss +0 -7
- package/lib/design-tokens/brands copy/marketing/footer.scss +0 -9
- package/lib/design-tokens/brands copy/marketing/header.scss +0 -81
- package/lib/design-tokens/brands copy/marketing/icon-size.scss +0 -6
- package/lib/design-tokens/brands copy/marketing/letterSpacing.scss +0 -9
- package/lib/design-tokens/brands copy/marketing/lineHeights.scss +0 -22
- package/lib/design-tokens/brands copy/marketing/link.scss +0 -4
- package/lib/design-tokens/brands copy/marketing/paragraphIndent.scss +0 -4
- package/lib/design-tokens/brands copy/marketing/paragraphSpacing.scss +0 -4
- package/lib/design-tokens/brands copy/marketing/progress-meter.scss +0 -4
- package/lib/design-tokens/brands copy/marketing/shadow.scss +0 -8
- package/lib/design-tokens/brands copy/marketing/spacing.scss +0 -21
- package/lib/design-tokens/brands copy/marketing/textCase.scss +0 -5
- package/lib/design-tokens/brands copy/marketing/textDecoration.scss +0 -5
- package/lib/design-tokens/brands copy/marketing/tokens-all-marketing.scss +0 -633
- package/lib/design-tokens/brands copy/marketing/tokens-brand.scss +0 -32
- package/lib/design-tokens/brands copy/minimalist/_base.scss +0 -81
- package/lib/design-tokens/brands copy/minimalist/asset.scss +0 -6
- package/lib/design-tokens/brands copy/minimalist/badge.scss +0 -5
- package/lib/design-tokens/brands copy/minimalist/bg.scss +0 -34
- package/lib/design-tokens/brands copy/minimalist/border-style.scss +0 -5
- package/lib/design-tokens/brands copy/minimalist/border.scss +0 -17
- package/lib/design-tokens/brands copy/minimalist/borderRadius.scss +0 -15
- package/lib/design-tokens/brands copy/minimalist/borderWidth.scss +0 -11
- package/lib/design-tokens/brands copy/minimalist/breakpoint.scss +0 -9
- package/lib/design-tokens/brands copy/minimalist/button.scss +0 -225
- package/lib/design-tokens/brands copy/minimalist/content.scss +0 -29
- package/lib/design-tokens/brands copy/minimalist/desktop-menu.scss +0 -5
- package/lib/design-tokens/brands copy/minimalist/fontFamilies.scss +0 -4
- package/lib/design-tokens/brands copy/minimalist/fontFamily.scss +0 -4
- package/lib/design-tokens/brands copy/minimalist/fontSize.scss +0 -17
- package/lib/design-tokens/brands copy/minimalist/fontWeights.scss +0 -6
- package/lib/design-tokens/brands copy/minimalist/footer.scss +0 -9
- package/lib/design-tokens/brands copy/minimalist/header.scss +0 -81
- package/lib/design-tokens/brands copy/minimalist/icon-size.scss +0 -6
- package/lib/design-tokens/brands copy/minimalist/letterSpacing.scss +0 -9
- package/lib/design-tokens/brands copy/minimalist/lineHeights.scss +0 -20
- package/lib/design-tokens/brands copy/minimalist/paragraphIndent.scss +0 -4
- package/lib/design-tokens/brands copy/minimalist/paragraphSpacing.scss +0 -4
- package/lib/design-tokens/brands copy/minimalist/progress-meter.scss +0 -4
- package/lib/design-tokens/brands copy/minimalist/shadow.scss +0 -8
- package/lib/design-tokens/brands copy/minimalist/spacing.scss +0 -20
- package/lib/design-tokens/brands copy/minimalist/textCase.scss +0 -5
- package/lib/design-tokens/brands copy/minimalist/textDecoration.scss +0 -5
- package/lib/design-tokens/brands copy/minimalist/tokens-all-minimalist.scss +0 -567
- package/lib/design-tokens/brands copy/minimalist/tokens-brand.scss +0 -32
|
@@ -0,0 +1,3844 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": "1.1.5",
|
|
3
|
+
"library": "@tmorrow/cre8-wc",
|
|
4
|
+
"tagPrefix": "cre8",
|
|
5
|
+
"description": "cre8 Web Components is a library of presentational UI web components to be consumed by # web applications.",
|
|
6
|
+
"framework": "Lit 3.3.1",
|
|
7
|
+
"components": [
|
|
8
|
+
{
|
|
9
|
+
"name": "cre8-button",
|
|
10
|
+
"category": "Actions",
|
|
11
|
+
"description": "The size and state of buttons on the screen serve as visual cues for the user\nabout what they can do and what they should do next.\nThey indicate the availability and priority of the action on the page.\n\n- Buttons are a single call-to-action where a single click performs that action\n- Use buttons when you are performing an action which is almost always on the same page\n- Use a link instead of a button when you're navigating to another place\n\n## How to Use\n\nButtons are distinguished by three key properties:\n\n- **Visual Priority**: Style and size: Primary, Secondary, or Tertiary styles;\n each with large and small variations\n- **State**: Interaction state: hover/click (press), focus, disabled,\n and submitting/loading (only for large buttons)\n- **Brand**: Styles determined by the site or component theme\n\n### Usage Guidelines\n\nPrimary, Secondary and Tertiary styles emphasize or de-emphasize an action. They also define\nbackground, font style, and border colors. Large and small sizing assists with visual priority by defining button\nheights, left and right internal padding, and font-size.\n\n#### System Feedback\nEach button has a default and hover/click (press) state that give the user feedback\nthat they have successfully interacted with a button.\nButton presses should always be combined with other types of timely system feedback.\nExamples of system feedback may be a page refresh, exposing additional controls or content,\ndialogs, alerts and notifications.\nIf there is perceived a delay in system response, generally due to technical constraints,\nprovide a progress or loading indicator.\n\n#### Button Text\n\n- Button text should be as short and simple as possible, ideally a maximum of 3 words.\n- Use Title Case for readability.\n- They should not include punctuation (exception: \"Loading...\").\n- They should not be used as an indicator of what happens on the next page, or as a substitute\nfor a progress meter.\n\n#### Button With Icon\n\nFor button with icon:\n- **iconRotateDegree** & **iconFlipDirection** props are optional.\n- They are used to set up the correct direction for icons, for example,\narrows, caret up or caret down.\n\n#### Button Styling\n\n- DO use only the styles of the brand you are working on.\n- DO NOT combine styles, even if the page is co-branded.\n\n#### Button Sizes\n- DO always pair like sizes together and maintain the hierarchy of Primary and Secondary/Tertiary.\n- DO NOT mix sizes of buttons when they are used together as a group.\n\n#### Input Pairing\n\nPrimary and Secondary buttons may be paired with input fields.\nOnly one Primary button may appear on each screen.\nUse the Secondary button when there are multiple in-context buttons\nand/or when there is an emphasized page level button.\nWhen used in a form context, the button's `type` needs to be `submit` to pass along form data.\n\n- DO use only large buttons with input fields.\n- DO NOT use small buttons with input fields.",
|
|
12
|
+
"attributes": {
|
|
13
|
+
"text": {
|
|
14
|
+
"type": "string",
|
|
15
|
+
"default": "Button",
|
|
16
|
+
"description": "The button text. Should be as short and simple as possible, ideally a maximum of 3 words.\n- Use Title Case for readability.\n- Should not include punctuation (exception: \"Loading...\").\n- Should not be used as an indicator of what happens on the next page, or as a substitute for a progress meter."
|
|
17
|
+
},
|
|
18
|
+
"variant": {
|
|
19
|
+
"type": "string",
|
|
20
|
+
"values": [
|
|
21
|
+
"primary",
|
|
22
|
+
"secondary",
|
|
23
|
+
"tertiary"
|
|
24
|
+
],
|
|
25
|
+
"default": "primary",
|
|
26
|
+
"description": "Style variant\n- **primary** renders the button used for primary actions. Presents highest visual priority.\n When grouped with other buttons, only one primary is allowed\n- **secondary** renders a secondary button. Presents a lower visual priority\n- **tertiary** renders a tertiary button. Presents the lowest visual priority.\n Should be used in limited amounts - consider if a link (`<a>`) would be more appropriate"
|
|
27
|
+
},
|
|
28
|
+
"neutral": {
|
|
29
|
+
"type": "boolean",
|
|
30
|
+
"description": "This property is for a neutral button propery mainly used for the secondary or tertiary button variant."
|
|
31
|
+
},
|
|
32
|
+
"inverse": {
|
|
33
|
+
"type": "boolean",
|
|
34
|
+
"description": "Inverse attribute"
|
|
35
|
+
},
|
|
36
|
+
"href": {
|
|
37
|
+
"type": "string",
|
|
38
|
+
"description": "\nProvide this property if you intend to use button styles for an anchor tag (`<a>`).\nThis changes the component markup from `<button>` usage to `<a>` instead."
|
|
39
|
+
},
|
|
40
|
+
"target": {
|
|
41
|
+
"type": "string",
|
|
42
|
+
"values": [
|
|
43
|
+
"_blank",
|
|
44
|
+
"_self",
|
|
45
|
+
"_parent",
|
|
46
|
+
"_top"
|
|
47
|
+
],
|
|
48
|
+
"description": "Target attribute for a link if providing `href` to style a link as a button\n- **_blank** yields a link that opens in a new tab\n- **_self** yields a link that loads the URL into the same browsing context as the current one.\n This is the default behavior\n- **_parent** yields a link that loads the URL into the parent browsing context of the current one.\n If there is no parent, this behaves the same way as _self\n- **_top** yields a link that loads the URL into the top-level browsing context.\n If there is no parent, this behaves the same way as _self."
|
|
49
|
+
},
|
|
50
|
+
"rel": {
|
|
51
|
+
"type": "string",
|
|
52
|
+
"description": "Rel if this is an <a> element - this swaps <button> for <a>"
|
|
53
|
+
},
|
|
54
|
+
"svg": {
|
|
55
|
+
"type": "string",
|
|
56
|
+
"description": "svg as a raw string\n- For button with icon, the icon is defined by this prop.\n- Pass in a raw svg as a String for using <cre8-icon>\n- Must include the icon's position with `iconPostion`."
|
|
57
|
+
},
|
|
58
|
+
"size": {
|
|
59
|
+
"type": "string",
|
|
60
|
+
"values": [
|
|
61
|
+
"sm",
|
|
62
|
+
"lg",
|
|
63
|
+
"md"
|
|
64
|
+
],
|
|
65
|
+
"default": "md",
|
|
66
|
+
"description": "Size variants add another way to increase or decrease visual priority of a button.\n- **sm** Shrinks the button typography and overall size from the default. Use when vertical space is constrained.\n- **md** This is the default value for the size.\n- **lg** Increases the button typography and overall size from the default."
|
|
67
|
+
},
|
|
68
|
+
"loading": {
|
|
69
|
+
"type": "boolean",
|
|
70
|
+
"description": "* Changes styling to an active state with a spinning icon.\n* Adds accessibility treatment by:\n * announcing via voiceover when the loading success/error state via a aria-live region\n * setting `aria-disabled`\n* Disables click events / form submitting while allowing focus (for accessibility)"
|
|
71
|
+
},
|
|
72
|
+
"type": {
|
|
73
|
+
"type": "string",
|
|
74
|
+
"values": [
|
|
75
|
+
"button",
|
|
76
|
+
"submit",
|
|
77
|
+
"reset"
|
|
78
|
+
],
|
|
79
|
+
"default": "button",
|
|
80
|
+
"description": "Type of button.\n- **button** (default) button has no default behavior and does nothing unless provided some sort\nof client-side trigger\n- **submit** button for submitting form data to a server"
|
|
81
|
+
},
|
|
82
|
+
"name": {
|
|
83
|
+
"type": "string",
|
|
84
|
+
"description": "The name of the form field"
|
|
85
|
+
},
|
|
86
|
+
"disabled": {
|
|
87
|
+
"type": "boolean",
|
|
88
|
+
"description": "Disabled attribute"
|
|
89
|
+
},
|
|
90
|
+
"required": {
|
|
91
|
+
"type": "boolean",
|
|
92
|
+
"description": "Whether the field is required"
|
|
93
|
+
},
|
|
94
|
+
"value": {
|
|
95
|
+
"type": "string",
|
|
96
|
+
"description": "The value of the form field."
|
|
97
|
+
}
|
|
98
|
+
},
|
|
99
|
+
"properties": {
|
|
100
|
+
"iconName": {
|
|
101
|
+
"type": "string",
|
|
102
|
+
"description": "Deprecated: iconName, use svg instead\nIcon name if including an icon within a button.\nMust include the icon's position with `iconPostion`. This prop is used for <cre8-icon-legacy>"
|
|
103
|
+
},
|
|
104
|
+
"iconRotateDegree": {
|
|
105
|
+
"type": "number",
|
|
106
|
+
"default": 0,
|
|
107
|
+
"description": "iconRotateDegree is used for <cre8-icon> to set the arrow in the correct direction"
|
|
108
|
+
},
|
|
109
|
+
"iconFlipDirection": {
|
|
110
|
+
"type": "string",
|
|
111
|
+
"description": "iconFlipDirection is used for <cre8-icon> to set the icon in the correct direction"
|
|
112
|
+
},
|
|
113
|
+
"iconPosition": {
|
|
114
|
+
"type": "string",
|
|
115
|
+
"values": [
|
|
116
|
+
"before",
|
|
117
|
+
"after"
|
|
118
|
+
],
|
|
119
|
+
"default": "undefined",
|
|
120
|
+
"description": "Icon position. Must include the name of the icon with `iconName`\n\n- **before** places the icon before the button text\n- **after** places the icon after the button text"
|
|
121
|
+
},
|
|
122
|
+
"hideText": {
|
|
123
|
+
"type": "boolean",
|
|
124
|
+
"description": "Visually hide button text. Text is still accessible to assistive technology.\nUse this for icon-only buttons for accessibility"
|
|
125
|
+
},
|
|
126
|
+
"fullWidth": {
|
|
127
|
+
"type": "boolean",
|
|
128
|
+
"description": "Full width button"
|
|
129
|
+
},
|
|
130
|
+
"loadingComplete": {
|
|
131
|
+
"type": "boolean",
|
|
132
|
+
"description": "* Variant of the loading button that:\n * Removes loading spinner\n * Informs the SR user that the loading status is now complete, with visually hidden text in the live area"
|
|
133
|
+
},
|
|
134
|
+
"ariaLive": {
|
|
135
|
+
"type": "string",
|
|
136
|
+
"values": [
|
|
137
|
+
"polite",
|
|
138
|
+
"assertive"
|
|
139
|
+
],
|
|
140
|
+
"default": "assertive",
|
|
141
|
+
"description": "Controls whether your loading status update to voiceover users will occur\nimmediately (used for more urgently needed updates) using `assertive` or at the next convenient\npause in their navigation using `polite`."
|
|
142
|
+
},
|
|
143
|
+
"splitButtonType": {
|
|
144
|
+
"type": "string",
|
|
145
|
+
"values": [
|
|
146
|
+
"text",
|
|
147
|
+
"caret"
|
|
148
|
+
],
|
|
149
|
+
"description": "These two subvariants of the split button style the two seperate buttons to style as a singular button"
|
|
150
|
+
},
|
|
151
|
+
"buttonAriaExpanded": {
|
|
152
|
+
"type": "boolean",
|
|
153
|
+
"description": "Button aria expanded attribute"
|
|
154
|
+
},
|
|
155
|
+
"isError": {
|
|
156
|
+
"type": "boolean",
|
|
157
|
+
"description": "Whether the field is in an error state"
|
|
158
|
+
},
|
|
159
|
+
"isSuccess": {
|
|
160
|
+
"type": "boolean",
|
|
161
|
+
"description": "Whether the field is in a success state"
|
|
162
|
+
}
|
|
163
|
+
},
|
|
164
|
+
"slots": {},
|
|
165
|
+
"events": {},
|
|
166
|
+
"cssProperties": {},
|
|
167
|
+
"examples": [
|
|
168
|
+
{
|
|
169
|
+
"description": "Primary button",
|
|
170
|
+
"html": "<cre8-button variant=\"primary\" text=\"Button\"></cre8-button>"
|
|
171
|
+
}
|
|
172
|
+
]
|
|
173
|
+
},
|
|
174
|
+
{
|
|
175
|
+
"name": "cre8-button-group",
|
|
176
|
+
"category": "Actions",
|
|
177
|
+
"description": "Button Group component.",
|
|
178
|
+
"attributes": {
|
|
179
|
+
"orientation": {
|
|
180
|
+
"type": "\"responsive-full-width\"",
|
|
181
|
+
"description": "Responsive Button Group (for modals)"
|
|
182
|
+
}
|
|
183
|
+
},
|
|
184
|
+
"properties": {},
|
|
185
|
+
"slots": {
|
|
186
|
+
"default": {
|
|
187
|
+
"description": "The component content"
|
|
188
|
+
}
|
|
189
|
+
},
|
|
190
|
+
"events": {},
|
|
191
|
+
"cssProperties": {},
|
|
192
|
+
"examples": []
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
"name": "cre8-danger-button",
|
|
196
|
+
"category": "Actions",
|
|
197
|
+
"description": "The size and state of buttons on the screen serve as visual cues for the user\nabout what they can do and what they should do next.\nThey indicate the availability and priority of the action on the page.\n\n- Buttons are a single call-to-action where a single click performs that action\n- Use Danger Buttons when you are performing an action that is potentially dangerous,\nsuch as permanently deleting information\n- Use a link instead of a button when you're navigating to another place\n\n## How to Use\n\nDanger Buttons are distinguished by three key properties:\n\n- **Visual Priority**: Style and size: Primary, Secondary, or Tertiary styles;\n each with large and small variations\n- **State**: Interaction state: hover/click (press), focus, disabled,\n and submitting/loading (only for large buttons)\n- **Brand**: Styles determined by the site or component theme\n\n### Usage Guidelines\n\nPrimary, Secondary and Tertiary styles emphasize or de-emphasize an action. They also define\nbackground, font style, and border colors. Large and small sizing assists with visual priority by defining button\nheights, left and right internal padding, and font-size.\n\n#### System Feedback\nEach button has a default and hover/click (press) state that give the user feedback\nthat they have successfully interacted with a button.\nButton presses should always be combined with other types of timely system feedback.\nExamples of system feedback may be a page refresh, exposing additional controls or content,\ndialogs, alerts and notifications.\nIf there is perceived a delay in system response, generally due to technical constraints,\nprovide a progress or loading indicator.\n\n#### Button Text\n\n- Button text should be as short and simple as possible, ideally a maximum of 3 words.\n- Use Title Case for readability.\n- They should not include punctuation (exception: \"Loading...\").\n- They should not be used as an indicator of what happens on the next page, or as a substitute\nfor a progress meter.\n\n#### Button Styling\n\n- DO use only the styles of the brand you are working on.\n- DO NOT combine styles, even if the page is co-branded.\n\n#### Button Sizes\n- DO always pair like sizes together and maintain the hierarchy of Primary and Secondary/Tertiary.\n- DO NOT mix sizes of buttons when they are used together as a group.\n\n#### Input Pairing\n\nPrimary and Secondary buttons may be paired with input fields.\nOnly one Primary button may appear on each screen.\nUse the Secondary button when there are multiple in-context buttons\nand/or when there is an emphasized page level button.\nWhen used in a form context, the button's `type` needs to be `submit` to pass along form data.\n\n- DO use only large buttons with input fields.\n- DO NOT use small buttons with input fields.",
|
|
198
|
+
"attributes": {
|
|
199
|
+
"text": {
|
|
200
|
+
"type": "string",
|
|
201
|
+
"default": "Button",
|
|
202
|
+
"description": "\nThe button text. Should be as short and simple as possible, ideally a maximum of 3 words.\n- Use Title Case for readability.\n- Should not include punctuation (exception: \"Loading...\").\n- Should not be used as an indicator of what happens on the next page, or as a substitute for a progress meter."
|
|
203
|
+
},
|
|
204
|
+
"variant": {
|
|
205
|
+
"type": "string",
|
|
206
|
+
"values": [
|
|
207
|
+
"primary",
|
|
208
|
+
"secondary",
|
|
209
|
+
"tertiary"
|
|
210
|
+
],
|
|
211
|
+
"default": "primary",
|
|
212
|
+
"description": "Style variant\n- **primary** renders the button used for primary actions. Presents highest visual priority.\n When grouped with other buttons, only one primary is allowed\n- **secondary** renders a secondary button. Presents a lower visual priority\n- **tertiary** renders a tertiary button. Presents the lowest visual priority.\n Should be used in limited amounts - consider if a link (`<a>`) would be more appropriate"
|
|
213
|
+
},
|
|
214
|
+
"href": {
|
|
215
|
+
"type": "string",
|
|
216
|
+
"description": "\nProvide this property if you intend to use button styles for an anchor tag (`<a>`).\nThis changes the component markup from `<button>` usage to `<a>` instead."
|
|
217
|
+
},
|
|
218
|
+
"target": {
|
|
219
|
+
"type": "string",
|
|
220
|
+
"values": [
|
|
221
|
+
"_blank",
|
|
222
|
+
"_self",
|
|
223
|
+
"_parent",
|
|
224
|
+
"_top"
|
|
225
|
+
],
|
|
226
|
+
"description": "Target attribute for a link if providing `href` to style a link as a button\n- **_blank** yields a link that opens in a new tab\n- **_self** yields a link that loads the URL into the same browsing context as the current one.\n This is the default behavior\n- **_parent** yields a link that loads the URL into the parent browsing context of the current one.\n If there is no parent, this behaves the same way as _self\n- **_top** yields a link that loads the URL into the top-level browsing context.\n If there is no parent, this behaves the same way as _self."
|
|
227
|
+
},
|
|
228
|
+
"rel": {
|
|
229
|
+
"type": "string",
|
|
230
|
+
"description": "Rel if this is an <a> element - this swaps <button> for <a>"
|
|
231
|
+
},
|
|
232
|
+
"svg": {
|
|
233
|
+
"type": "string",
|
|
234
|
+
"description": "SVG raw string if including an icon within a button.\nMust include the icon's position with `iconPostion`. This prop is used for <cre8-icon>"
|
|
235
|
+
},
|
|
236
|
+
"size": {
|
|
237
|
+
"type": "string",
|
|
238
|
+
"values": [
|
|
239
|
+
"sm",
|
|
240
|
+
"lg"
|
|
241
|
+
],
|
|
242
|
+
"description": "Size variants add another way to increase or decrease visual priority of a button.\n- **sm** shrinks the button typography and overall size from the default. Use when vertical space is constrained.\n- **lg** increases the button typography and overall size from the default."
|
|
243
|
+
},
|
|
244
|
+
"loading": {
|
|
245
|
+
"type": "boolean",
|
|
246
|
+
"description": "* Changes styling to an active state with a spinning icon.\n* Adds accessibility treatment by:\n * announcing via voiceover when the loading success/error state via a aria-live region\n * setting `aria-disabled`\n* Disables click events / form submitting while allowing focus (for accessibility)"
|
|
247
|
+
},
|
|
248
|
+
"inverted": {
|
|
249
|
+
"type": "boolean",
|
|
250
|
+
"description": "Inverted colors Danger Button (onDark)"
|
|
251
|
+
},
|
|
252
|
+
"type": {
|
|
253
|
+
"type": "string",
|
|
254
|
+
"values": [
|
|
255
|
+
"button",
|
|
256
|
+
"submit",
|
|
257
|
+
"reset"
|
|
258
|
+
],
|
|
259
|
+
"default": "button",
|
|
260
|
+
"description": "Type of button.\n- **button** (default) button has no default behavior and does nothing unless provided some sort\nof client-side trigger\n- **submit** button for submitting form data to a server"
|
|
261
|
+
},
|
|
262
|
+
"name": {
|
|
263
|
+
"type": "string",
|
|
264
|
+
"description": "The name of the form field"
|
|
265
|
+
},
|
|
266
|
+
"disabled": {
|
|
267
|
+
"type": "boolean",
|
|
268
|
+
"description": "Disabled attribute"
|
|
269
|
+
},
|
|
270
|
+
"required": {
|
|
271
|
+
"type": "boolean",
|
|
272
|
+
"description": "Whether the field is required"
|
|
273
|
+
},
|
|
274
|
+
"value": {
|
|
275
|
+
"type": "string",
|
|
276
|
+
"description": "The value of the form field."
|
|
277
|
+
}
|
|
278
|
+
},
|
|
279
|
+
"properties": {
|
|
280
|
+
"iconRotateDegree": {
|
|
281
|
+
"type": "number",
|
|
282
|
+
"default": 0,
|
|
283
|
+
"description": "rotate is used for <cre8-icon> to set the arrow in the correct direction"
|
|
284
|
+
},
|
|
285
|
+
"iconFlipDirection": {
|
|
286
|
+
"type": "string",
|
|
287
|
+
"description": "flip is used for <cre8-icon> to set the icon in the correct direction"
|
|
288
|
+
},
|
|
289
|
+
"iconPosition": {
|
|
290
|
+
"type": "string",
|
|
291
|
+
"values": [
|
|
292
|
+
"before",
|
|
293
|
+
"after"
|
|
294
|
+
],
|
|
295
|
+
"default": "undefined",
|
|
296
|
+
"description": "Icon position. Must include the name of the icon with `iconName`\n\n- **before** places the icon before the button text\n- **after** places the icon after the button text"
|
|
297
|
+
},
|
|
298
|
+
"hideText": {
|
|
299
|
+
"type": "boolean",
|
|
300
|
+
"description": "Visually hide button text. Text is still accessible to assistive technology.\nUse this for icon-only buttons for accessibility"
|
|
301
|
+
},
|
|
302
|
+
"fullWidth": {
|
|
303
|
+
"type": "boolean",
|
|
304
|
+
"description": "Full width button"
|
|
305
|
+
},
|
|
306
|
+
"loadingComplete": {
|
|
307
|
+
"type": "boolean",
|
|
308
|
+
"description": "* Variant of the loading button that:\n * Removes loading spinner\n * Informs the SR user that the loading status is now complete, with visually hidden text in the live area"
|
|
309
|
+
},
|
|
310
|
+
"ariaLive": {
|
|
311
|
+
"type": "string",
|
|
312
|
+
"values": [
|
|
313
|
+
"polite",
|
|
314
|
+
"assertive"
|
|
315
|
+
],
|
|
316
|
+
"default": "assertive",
|
|
317
|
+
"description": "Controls whether your loading status update to voiceover users will occur\nimmediately (used for more urgently needed updates) using `assertive` or at the next convenient\npause in their navigation using `polite`."
|
|
318
|
+
},
|
|
319
|
+
"buttonAriaExpanded": {
|
|
320
|
+
"type": "boolean",
|
|
321
|
+
"description": "Button aria expanded attribute"
|
|
322
|
+
},
|
|
323
|
+
"isError": {
|
|
324
|
+
"type": "boolean",
|
|
325
|
+
"description": "Whether the field is in an error state"
|
|
326
|
+
},
|
|
327
|
+
"isSuccess": {
|
|
328
|
+
"type": "boolean",
|
|
329
|
+
"description": "Whether the field is in a success state"
|
|
330
|
+
}
|
|
331
|
+
},
|
|
332
|
+
"slots": {},
|
|
333
|
+
"events": {},
|
|
334
|
+
"cssProperties": {},
|
|
335
|
+
"examples": [
|
|
336
|
+
{
|
|
337
|
+
"description": "Primary danger-button",
|
|
338
|
+
"html": "<cre8-danger-button variant=\"primary\" text=\"Danger Button\"></cre8-danger-button>"
|
|
339
|
+
}
|
|
340
|
+
]
|
|
341
|
+
},
|
|
342
|
+
{
|
|
343
|
+
"name": "cre8-split-button",
|
|
344
|
+
"category": "Actions",
|
|
345
|
+
"description": "Split Button component.",
|
|
346
|
+
"attributes": {
|
|
347
|
+
"disabled": {
|
|
348
|
+
"type": "boolean"
|
|
349
|
+
},
|
|
350
|
+
"size": {
|
|
351
|
+
"type": "string",
|
|
352
|
+
"values": [
|
|
353
|
+
"sm",
|
|
354
|
+
"lg"
|
|
355
|
+
],
|
|
356
|
+
"description": "Size variant\n<cre8-text-passage size=\"sm\">\n<ul>\n<li>**sm** shrinks the button typography and overall size</li>\n<li>**lg** increases the button typography size and overall size</li>\n</ul>\n</cre8-text-passage>"
|
|
357
|
+
}
|
|
358
|
+
},
|
|
359
|
+
"properties": {
|
|
360
|
+
"buttonText": {
|
|
361
|
+
"type": "string",
|
|
362
|
+
"description": "Display text on the button"
|
|
363
|
+
},
|
|
364
|
+
"dropdownOpen": {
|
|
365
|
+
"type": "boolean"
|
|
366
|
+
}
|
|
367
|
+
},
|
|
368
|
+
"slots": {
|
|
369
|
+
"default": {
|
|
370
|
+
"description": "The component content , this will consist of the dropdown when the user clicks the caret"
|
|
371
|
+
}
|
|
372
|
+
},
|
|
373
|
+
"events": {
|
|
374
|
+
"text-click": {
|
|
375
|
+
"detail": {}
|
|
376
|
+
},
|
|
377
|
+
"dropdown-click": {
|
|
378
|
+
"detail": {}
|
|
379
|
+
}
|
|
380
|
+
},
|
|
381
|
+
"cssProperties": {},
|
|
382
|
+
"examples": []
|
|
383
|
+
},
|
|
384
|
+
{
|
|
385
|
+
"name": "cre8-chart",
|
|
386
|
+
"category": "Data",
|
|
387
|
+
"description": "A flexible chart component built on Chart.js that supports multiple chart types\nincluding line, bar, pie, doughnut, radar, polar area, bubble, and scatter charts.\n\n## Features\n- Supports all major Chart.js chart types\n- Reactive updates when data or options change\n- Customizable colors that integrate with cre8 design tokens\n- Responsive sizing\n- Loading state indicator\n- Event callbacks for click and hover interactions\n- Accessible with ARIA labels\n\n## Usage\n\n```html\n<cre8-chart\n type=\"bar\"\n .data=${{ labels: ['A', 'B', 'C'], datasets: [{ label: 'Sales', data: [10, 20, 30] }] }}\n .options=${{ responsive: true }}\n></cre8-chart>\n```",
|
|
388
|
+
"attributes": {
|
|
389
|
+
"type": {
|
|
390
|
+
"type": "Cre8ChartType",
|
|
391
|
+
"default": "bar",
|
|
392
|
+
"description": "The type of chart to render."
|
|
393
|
+
},
|
|
394
|
+
"width": {
|
|
395
|
+
"type": "number",
|
|
396
|
+
"description": "Width of the chart container in pixels.\nIf not set, the chart will be responsive."
|
|
397
|
+
},
|
|
398
|
+
"height": {
|
|
399
|
+
"type": "number",
|
|
400
|
+
"default": 400,
|
|
401
|
+
"description": "Height of the chart container in pixels.\nIf not set, defaults to 400px."
|
|
402
|
+
},
|
|
403
|
+
"maintain-aspect-ratio": {
|
|
404
|
+
"type": "boolean",
|
|
405
|
+
"default": true,
|
|
406
|
+
"description": "Whether the chart should maintain aspect ratio when resizing."
|
|
407
|
+
},
|
|
408
|
+
"responsive": {
|
|
409
|
+
"type": "boolean",
|
|
410
|
+
"default": true,
|
|
411
|
+
"description": "Whether the chart should be responsive to container size."
|
|
412
|
+
},
|
|
413
|
+
"loading": {
|
|
414
|
+
"type": "boolean",
|
|
415
|
+
"default": false,
|
|
416
|
+
"description": "Display a loading indicator instead of the chart."
|
|
417
|
+
},
|
|
418
|
+
"aria-label": {
|
|
419
|
+
"type": "string",
|
|
420
|
+
"default": "Chart",
|
|
421
|
+
"description": "Accessible label for the chart."
|
|
422
|
+
},
|
|
423
|
+
"show-legend": {
|
|
424
|
+
"type": "boolean",
|
|
425
|
+
"default": true,
|
|
426
|
+
"description": "Whether to show the legend."
|
|
427
|
+
},
|
|
428
|
+
"legend-position": {
|
|
429
|
+
"type": "string",
|
|
430
|
+
"values": [
|
|
431
|
+
"top",
|
|
432
|
+
"bottom",
|
|
433
|
+
"left",
|
|
434
|
+
"right"
|
|
435
|
+
],
|
|
436
|
+
"default": "top",
|
|
437
|
+
"description": "Position of the legend."
|
|
438
|
+
},
|
|
439
|
+
"enable-animation": {
|
|
440
|
+
"type": "boolean",
|
|
441
|
+
"default": true,
|
|
442
|
+
"description": "Whether to animate chart updates."
|
|
443
|
+
},
|
|
444
|
+
"animation-duration": {
|
|
445
|
+
"type": "number",
|
|
446
|
+
"default": 750,
|
|
447
|
+
"description": "Animation duration in milliseconds."
|
|
448
|
+
}
|
|
449
|
+
},
|
|
450
|
+
"properties": {
|
|
451
|
+
"data": {
|
|
452
|
+
"type": "Cre8ChartData",
|
|
453
|
+
"description": "The chart data including labels and datasets.\nThis should be an object with `labels` array and `datasets` array."
|
|
454
|
+
},
|
|
455
|
+
"options": {
|
|
456
|
+
"type": "_DeepPartialObject<CoreChartOptions<keyof ChartTypeRegistry> & ElementChartOptions<keyof ChartTypeRegistry> & PluginChartOptions<...> & DatasetChartOptions<...> & ScaleChartOptions<...>>",
|
|
457
|
+
"description": "Chart.js configuration options.\nSee Chart.js documentation for all available options."
|
|
458
|
+
},
|
|
459
|
+
"colors": {
|
|
460
|
+
"type": "string[]",
|
|
461
|
+
"description": "Default colors for datasets (uses cre8 design token colors)."
|
|
462
|
+
}
|
|
463
|
+
},
|
|
464
|
+
"slots": {},
|
|
465
|
+
"events": {
|
|
466
|
+
"cre8-chart-click": {
|
|
467
|
+
"detail": {},
|
|
468
|
+
"description": "Fired when a chart element is clicked"
|
|
469
|
+
},
|
|
470
|
+
"cre8-chart-hover": {
|
|
471
|
+
"detail": {},
|
|
472
|
+
"description": "Fired when hovering over chart elements"
|
|
473
|
+
},
|
|
474
|
+
"cre8-chart-ready": {
|
|
475
|
+
"detail": {},
|
|
476
|
+
"description": "Fired when the chart is initialized"
|
|
477
|
+
}
|
|
478
|
+
},
|
|
479
|
+
"cssProperties": {},
|
|
480
|
+
"examples": []
|
|
481
|
+
},
|
|
482
|
+
{
|
|
483
|
+
"name": "cre8-list",
|
|
484
|
+
"category": "Data",
|
|
485
|
+
"description": "List component.",
|
|
486
|
+
"attributes": {
|
|
487
|
+
"variant": {
|
|
488
|
+
"type": "\"bare\"",
|
|
489
|
+
"description": "Style variants\n<cre8-text-passage size=\"sm\">\n<ul>\n<li>**bare** removes any lines from in between list items</li>\n</ul>\n</cre8-text-passage>"
|
|
490
|
+
},
|
|
491
|
+
"spacing": {
|
|
492
|
+
"type": "string",
|
|
493
|
+
"values": [
|
|
494
|
+
"condensed",
|
|
495
|
+
"padded"
|
|
496
|
+
],
|
|
497
|
+
"description": "Spacing variants\n<cre8-text-passage size=\"sm\">\n<ul>\n<li>**padded** applies more padding in between list items compared to the default</li>\n<li>**condensed** reduces padding in between list items compared to the default</li>\n</ul>\n</cre8-text-passage>"
|
|
498
|
+
}
|
|
499
|
+
},
|
|
500
|
+
"properties": {},
|
|
501
|
+
"slots": {
|
|
502
|
+
"default": {
|
|
503
|
+
"description": "The list items"
|
|
504
|
+
}
|
|
505
|
+
},
|
|
506
|
+
"events": {},
|
|
507
|
+
"cssProperties": {},
|
|
508
|
+
"examples": []
|
|
509
|
+
},
|
|
510
|
+
{
|
|
511
|
+
"name": "cre8-list-item",
|
|
512
|
+
"category": "Data",
|
|
513
|
+
"description": "List Item component.",
|
|
514
|
+
"attributes": {},
|
|
515
|
+
"properties": {},
|
|
516
|
+
"slots": {
|
|
517
|
+
"default": {
|
|
518
|
+
"description": "The content of the list item"
|
|
519
|
+
}
|
|
520
|
+
},
|
|
521
|
+
"events": {},
|
|
522
|
+
"cssProperties": {},
|
|
523
|
+
"examples": []
|
|
524
|
+
},
|
|
525
|
+
{
|
|
526
|
+
"name": "cre8-remove-tag",
|
|
527
|
+
"category": "Data",
|
|
528
|
+
"description": "Clicking a Remove Tag causes it to disappear from the page or field (in the case of Multi-Select).\nThese tags always display a \"Close\" icon.",
|
|
529
|
+
"attributes": {
|
|
530
|
+
"text": {
|
|
531
|
+
"type": "string",
|
|
532
|
+
"description": "The tag text"
|
|
533
|
+
},
|
|
534
|
+
"color": {
|
|
535
|
+
"type": "Color",
|
|
536
|
+
"default": "neutral",
|
|
537
|
+
"description": "The tag color scheme\n\n - **neutral** should be used when doing non-link actions such as filters or multi-select, within forms, etc.\n - **neutral-hybrid** should be used for when tags are doing an action like a button or a link\n - **branded** should be used like Neutral, but for marketing / actionable items"
|
|
538
|
+
},
|
|
539
|
+
"shape": {
|
|
540
|
+
"type": "Shape",
|
|
541
|
+
"default": "round",
|
|
542
|
+
"description": "The tag shape\n\n- **round** will give the tag a rounded border\n- **square** will give the tag a squared border"
|
|
543
|
+
},
|
|
544
|
+
"disabled": {
|
|
545
|
+
"type": "boolean",
|
|
546
|
+
"description": "Disabled state for remove tag"
|
|
547
|
+
}
|
|
548
|
+
},
|
|
549
|
+
"properties": {},
|
|
550
|
+
"slots": {},
|
|
551
|
+
"events": {
|
|
552
|
+
"removeTagClicked": {
|
|
553
|
+
"detail": {}
|
|
554
|
+
}
|
|
555
|
+
},
|
|
556
|
+
"cssProperties": {},
|
|
557
|
+
"examples": [
|
|
558
|
+
{
|
|
559
|
+
"description": "Basic remove-tag",
|
|
560
|
+
"html": "<cre8-remove-tag text=\"Remove Tag\"></cre8-remove-tag>"
|
|
561
|
+
}
|
|
562
|
+
]
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
"name": "cre8-table",
|
|
566
|
+
"category": "Data",
|
|
567
|
+
"description": "Table component.",
|
|
568
|
+
"attributes": {
|
|
569
|
+
"caption": {
|
|
570
|
+
"type": "string",
|
|
571
|
+
"description": "Specifies the caption/title of the table, visible to all users.\nIncreases accessibility of table."
|
|
572
|
+
},
|
|
573
|
+
"behavior": {
|
|
574
|
+
"type": "\"responsive\"",
|
|
575
|
+
"description": "Behavior variants\n<cre8-text-passage size=\"sm\">\n<ul>\n<li>**responsive** stacks column headers with respective table cells on small screens</li>\n</ul>\n</cre8-text-passage>"
|
|
576
|
+
},
|
|
577
|
+
"variant": {
|
|
578
|
+
"type": "\"striped\"",
|
|
579
|
+
"description": "Style variants\n<cre8-text-passage size=\"sm\">\n<ul>\n<li>**striped** add zebra-striping to table rows within the `<tbody>`</li>\n</ul>\n</cre8-text-passage>"
|
|
580
|
+
}
|
|
581
|
+
},
|
|
582
|
+
"properties": {
|
|
583
|
+
"isHoverable": {
|
|
584
|
+
"type": "boolean",
|
|
585
|
+
"description": "Hoverable rows variant\n1) Allows the table rows to be styled on hover"
|
|
586
|
+
}
|
|
587
|
+
},
|
|
588
|
+
"slots": {
|
|
589
|
+
"default": {
|
|
590
|
+
"description": "The component content"
|
|
591
|
+
}
|
|
592
|
+
},
|
|
593
|
+
"events": {},
|
|
594
|
+
"cssProperties": {},
|
|
595
|
+
"examples": []
|
|
596
|
+
},
|
|
597
|
+
{
|
|
598
|
+
"name": "cre8-table-body",
|
|
599
|
+
"category": "Data",
|
|
600
|
+
"description": "Table Body component.",
|
|
601
|
+
"attributes": {},
|
|
602
|
+
"properties": {},
|
|
603
|
+
"slots": {
|
|
604
|
+
"default": {
|
|
605
|
+
"description": "The component content"
|
|
606
|
+
}
|
|
607
|
+
},
|
|
608
|
+
"events": {},
|
|
609
|
+
"cssProperties": {},
|
|
610
|
+
"examples": []
|
|
611
|
+
},
|
|
612
|
+
{
|
|
613
|
+
"name": "cre8-table-cell",
|
|
614
|
+
"category": "Data",
|
|
615
|
+
"description": "Table Cell component.",
|
|
616
|
+
"attributes": {
|
|
617
|
+
"colspan": {
|
|
618
|
+
"type": "number",
|
|
619
|
+
"description": "Colspan attribute on td"
|
|
620
|
+
},
|
|
621
|
+
"variant": {
|
|
622
|
+
"type": "\"bare\"",
|
|
623
|
+
"description": "Style variants\n<cre8-text-passage size=\"sm\">\n<ul>\n<li>**bare** renders a table cell without a border</li>\n</ul>\n</cre8-text-passage>"
|
|
624
|
+
}
|
|
625
|
+
},
|
|
626
|
+
"properties": {
|
|
627
|
+
"dataHeader": {
|
|
628
|
+
"type": "string",
|
|
629
|
+
"description": "Column header text for cell to display when table is using responsive variant"
|
|
630
|
+
}
|
|
631
|
+
},
|
|
632
|
+
"slots": {
|
|
633
|
+
"default": {
|
|
634
|
+
"description": "The component content"
|
|
635
|
+
}
|
|
636
|
+
},
|
|
637
|
+
"events": {},
|
|
638
|
+
"cssProperties": {},
|
|
639
|
+
"examples": []
|
|
640
|
+
},
|
|
641
|
+
{
|
|
642
|
+
"name": "cre8-table-header",
|
|
643
|
+
"category": "Data",
|
|
644
|
+
"description": "Table Header component.",
|
|
645
|
+
"attributes": {},
|
|
646
|
+
"properties": {},
|
|
647
|
+
"slots": {
|
|
648
|
+
"default": {
|
|
649
|
+
"description": "The component content"
|
|
650
|
+
}
|
|
651
|
+
},
|
|
652
|
+
"events": {},
|
|
653
|
+
"cssProperties": {},
|
|
654
|
+
"examples": []
|
|
655
|
+
},
|
|
656
|
+
{
|
|
657
|
+
"name": "cre8-table-header-cell",
|
|
658
|
+
"category": "Data",
|
|
659
|
+
"description": "Table Header Cell component.",
|
|
660
|
+
"attributes": {
|
|
661
|
+
"colspan": {
|
|
662
|
+
"type": "number",
|
|
663
|
+
"description": "Colspan attribute on th"
|
|
664
|
+
},
|
|
665
|
+
"width": {
|
|
666
|
+
"type": "string",
|
|
667
|
+
"description": "Adds inline width style to th\nSets width of entire column"
|
|
668
|
+
}
|
|
669
|
+
},
|
|
670
|
+
"properties": {},
|
|
671
|
+
"slots": {
|
|
672
|
+
"default": {
|
|
673
|
+
"description": "The component content"
|
|
674
|
+
}
|
|
675
|
+
},
|
|
676
|
+
"events": {},
|
|
677
|
+
"cssProperties": {},
|
|
678
|
+
"examples": []
|
|
679
|
+
},
|
|
680
|
+
{
|
|
681
|
+
"name": "cre8-table-object",
|
|
682
|
+
"category": "Data",
|
|
683
|
+
"description": "Table Object component.",
|
|
684
|
+
"attributes": {},
|
|
685
|
+
"properties": {},
|
|
686
|
+
"slots": {
|
|
687
|
+
"default": {
|
|
688
|
+
"description": "The component content"
|
|
689
|
+
}
|
|
690
|
+
},
|
|
691
|
+
"events": {},
|
|
692
|
+
"cssProperties": {},
|
|
693
|
+
"examples": []
|
|
694
|
+
},
|
|
695
|
+
{
|
|
696
|
+
"name": "cre8-table-row",
|
|
697
|
+
"category": "Data",
|
|
698
|
+
"description": "Table Row component.",
|
|
699
|
+
"attributes": {
|
|
700
|
+
"variant": {
|
|
701
|
+
"type": "\"bare\"",
|
|
702
|
+
"description": "Style variants\n<cre8-text-passage size=\"sm\">\n<ul>\n<li>**bare** renders a table row without a border</li>\n</ul>\n</cre8-text-passage>"
|
|
703
|
+
}
|
|
704
|
+
},
|
|
705
|
+
"properties": {
|
|
706
|
+
"isExpanded": {
|
|
707
|
+
"type": "boolean",
|
|
708
|
+
"description": "Visually show additional expandable content"
|
|
709
|
+
},
|
|
710
|
+
"isExpandable": {
|
|
711
|
+
"type": "boolean",
|
|
712
|
+
"description": "Indicates row has additional visually hidden related content"
|
|
713
|
+
},
|
|
714
|
+
"expandedButtonText": {
|
|
715
|
+
"type": "string",
|
|
716
|
+
"default": "Collapse Table Row",
|
|
717
|
+
"description": "Expanded button text"
|
|
718
|
+
},
|
|
719
|
+
"collapsedButtonText": {
|
|
720
|
+
"type": "string",
|
|
721
|
+
"default": "Expand Table Row",
|
|
722
|
+
"description": "Expand button text"
|
|
723
|
+
}
|
|
724
|
+
},
|
|
725
|
+
"slots": {
|
|
726
|
+
"default": {
|
|
727
|
+
"description": "The component content"
|
|
728
|
+
}
|
|
729
|
+
},
|
|
730
|
+
"events": {},
|
|
731
|
+
"cssProperties": {},
|
|
732
|
+
"examples": []
|
|
733
|
+
},
|
|
734
|
+
{
|
|
735
|
+
"name": "cre8-tag",
|
|
736
|
+
"category": "Data",
|
|
737
|
+
"description": "The tag component allows you to make selections, filter content, or trigger actions. While buttons are\nexpected to appear consistently and with familiar calls to actions, tags should appear dynamically\nas a group of multiple interactions elements. It is a flexible\ncomponent that comes in the following types:\n - **radio** Clicking a Radio Button causes it to change color. These tags only allow\none option to be chosen and can be used in place of radio button when they need to be listed\nhorizontally\n\n - **checkbox** It allows for selecting options, It can be toggled on and off.",
|
|
738
|
+
"attributes": {
|
|
739
|
+
"text": {
|
|
740
|
+
"type": "string"
|
|
741
|
+
},
|
|
742
|
+
"variant": {
|
|
743
|
+
"type": "string",
|
|
744
|
+
"values": [
|
|
745
|
+
"neutral",
|
|
746
|
+
"branded",
|
|
747
|
+
"neutral-hybrid"
|
|
748
|
+
],
|
|
749
|
+
"default": "neutral",
|
|
750
|
+
"description": "Color variant\n**neutral** renders the default, unselected tag\n**branded** renders a selected tag\n**neutral-hybrid** renders a tag when mouse is hovering tag"
|
|
751
|
+
},
|
|
752
|
+
"shape": {
|
|
753
|
+
"type": "string",
|
|
754
|
+
"values": [
|
|
755
|
+
"square",
|
|
756
|
+
"round"
|
|
757
|
+
],
|
|
758
|
+
"default": "square",
|
|
759
|
+
"description": "shape of the tag, supports square and round, and default not mentioned its a square"
|
|
760
|
+
},
|
|
761
|
+
"type": {
|
|
762
|
+
"type": "string",
|
|
763
|
+
"values": [
|
|
764
|
+
"checkbox",
|
|
765
|
+
"radio"
|
|
766
|
+
],
|
|
767
|
+
"description": "Type of tag\n**checkbox** renders a checkbox tag\n**radio** renders a radio tag"
|
|
768
|
+
},
|
|
769
|
+
"name": {
|
|
770
|
+
"type": "string",
|
|
771
|
+
"description": "The name of the form field"
|
|
772
|
+
},
|
|
773
|
+
"disabled": {
|
|
774
|
+
"type": "boolean",
|
|
775
|
+
"description": "Whether the field is disabled"
|
|
776
|
+
},
|
|
777
|
+
"required": {
|
|
778
|
+
"type": "boolean",
|
|
779
|
+
"description": "Whether the field is required"
|
|
780
|
+
},
|
|
781
|
+
"value": {
|
|
782
|
+
"type": "string",
|
|
783
|
+
"description": "The value of the form field."
|
|
784
|
+
}
|
|
785
|
+
},
|
|
786
|
+
"properties": {
|
|
787
|
+
"isDisabled": {
|
|
788
|
+
"type": "boolean",
|
|
789
|
+
"description": "Disabled attribute\nrenders a greyed out tag that the user cannot interact with"
|
|
790
|
+
},
|
|
791
|
+
"isSelected": {
|
|
792
|
+
"type": "boolean",
|
|
793
|
+
"description": "Selected attribute\nrenders a selected tag"
|
|
794
|
+
},
|
|
795
|
+
"fieldId": {
|
|
796
|
+
"type": "string",
|
|
797
|
+
"description": "The fieldId attribute is assigned to the HTML input element of the radio button and the for attribute of the\ncorresponding label."
|
|
798
|
+
},
|
|
799
|
+
"isError": {
|
|
800
|
+
"type": "boolean",
|
|
801
|
+
"description": "Whether the field is in an error state"
|
|
802
|
+
},
|
|
803
|
+
"isSuccess": {
|
|
804
|
+
"type": "boolean",
|
|
805
|
+
"description": "Whether the field is in a success state"
|
|
806
|
+
}
|
|
807
|
+
},
|
|
808
|
+
"slots": {},
|
|
809
|
+
"events": {
|
|
810
|
+
"change": {
|
|
811
|
+
"detail": {}
|
|
812
|
+
}
|
|
813
|
+
},
|
|
814
|
+
"cssProperties": {},
|
|
815
|
+
"examples": [
|
|
816
|
+
{
|
|
817
|
+
"description": "Neutral tag",
|
|
818
|
+
"html": "<cre8-tag variant=\"neutral\" text=\"Tag\"></cre8-tag>"
|
|
819
|
+
}
|
|
820
|
+
]
|
|
821
|
+
},
|
|
822
|
+
{
|
|
823
|
+
"name": "cre8-tag-list",
|
|
824
|
+
"category": "Data",
|
|
825
|
+
"description": "Tag List must have children which are Tag components that are of type `checkbox` or `radio`.\nThe Tags must use the `neutral` variant and the `round` shape when they are inside a Tag List.\nTag List has a label that should be used to describe the purpose of the list.",
|
|
826
|
+
"attributes": {
|
|
827
|
+
"label": {
|
|
828
|
+
"type": "string",
|
|
829
|
+
"description": "Tag list legend label"
|
|
830
|
+
}
|
|
831
|
+
},
|
|
832
|
+
"properties": {
|
|
833
|
+
"fieldId": {
|
|
834
|
+
"type": "string",
|
|
835
|
+
"description": "The unique id of the select"
|
|
836
|
+
}
|
|
837
|
+
},
|
|
838
|
+
"slots": {},
|
|
839
|
+
"events": {},
|
|
840
|
+
"cssProperties": {},
|
|
841
|
+
"examples": []
|
|
842
|
+
},
|
|
843
|
+
{
|
|
844
|
+
"name": "cre8-accordion",
|
|
845
|
+
"category": "Disclosure",
|
|
846
|
+
"description": "The component is a vertically stacked list of headers that reveal or hide sections of related content on a page.\nThe header title gives the user a high level overview of the content allowing the user to decide\nwhich sections to expand for the information.\n\nAccordion contains Accordion Items as children. This component is the wrapper for grouping related accordion items.\n\nUsers can select different border types: default (no border), rectangle, rounded bottom, and rounded.",
|
|
847
|
+
"attributes": {},
|
|
848
|
+
"properties": {
|
|
849
|
+
"borderType": {
|
|
850
|
+
"type": "string",
|
|
851
|
+
"values": [
|
|
852
|
+
"rectangle",
|
|
853
|
+
"rounded-bottom",
|
|
854
|
+
"rounded",
|
|
855
|
+
"none"
|
|
856
|
+
],
|
|
857
|
+
"description": "borderType"
|
|
858
|
+
},
|
|
859
|
+
"hasDivider": {
|
|
860
|
+
"type": "boolean",
|
|
861
|
+
"default": false,
|
|
862
|
+
"description": "\nWhen it is true, the inner dividers are displayed;\nif it is false, the inner dividers are not displayed"
|
|
863
|
+
}
|
|
864
|
+
},
|
|
865
|
+
"slots": {},
|
|
866
|
+
"events": {},
|
|
867
|
+
"cssProperties": {},
|
|
868
|
+
"examples": []
|
|
869
|
+
},
|
|
870
|
+
{
|
|
871
|
+
"name": "cre8-accordion-item",
|
|
872
|
+
"category": "Disclosure",
|
|
873
|
+
"description": "\nThe accordion item component delivers large amounts of content in a small space\nthrough progressive disclosure. That is, the user gets key details about the\nunderlying content and can choose to expand that content within the constraints\nof the accordion item. Accordion Items work especially well on mobile interfaces or\nwhenever vertical space is at a premium.\n\n## HOW TO USE\nAvoid “nested” accordion items—that is, collapsible content within collapsible content.\nThis type of pattern goes against UX best practices.\n\nThe Cre8 accordion item header allows for two sizes:\n'sm' [cre8-typography-title-default] or 'lg' [cre8-typography-title-large]\n\nA chevron is used to indicate the “expand/collapse” action, though the entire\nheader area is clickable for the same action.\n\n**NOTE**: The header of the accordion item uses h tags so be sure to choose the headingTagVariant that\nfits into the hierarchy of your html page layout. THIS WILL NOT CHANGE THE APPEARANCE OF THE HEADER.",
|
|
874
|
+
"attributes": {
|
|
875
|
+
"size": {
|
|
876
|
+
"type": "string",
|
|
877
|
+
"values": [
|
|
878
|
+
"sm",
|
|
879
|
+
"lg"
|
|
880
|
+
],
|
|
881
|
+
"default": "sm",
|
|
882
|
+
"description": "\nUsers can choose between two header sizes: 'sm' [title-default] or 'lg' [title-large]."
|
|
883
|
+
},
|
|
884
|
+
"heading": {
|
|
885
|
+
"type": "string",
|
|
886
|
+
"description": "\nControls the text content of the Accordion Item heading."
|
|
887
|
+
}
|
|
888
|
+
},
|
|
889
|
+
"properties": {
|
|
890
|
+
"isActive": {
|
|
891
|
+
"type": "boolean",
|
|
892
|
+
"default": false,
|
|
893
|
+
"description": "\nWhen true, the Accordion Item is opens, when false it closes;"
|
|
894
|
+
},
|
|
895
|
+
"iconBefore": {
|
|
896
|
+
"type": "boolean",
|
|
897
|
+
"description": "\nControls the positioning of the dropdown icon in relation to the text, true puts the icon before the text\nand false/undefined default the icon to the opposite side of the accordion item"
|
|
898
|
+
},
|
|
899
|
+
"tertiaryIcon": {
|
|
900
|
+
"type": "boolean",
|
|
901
|
+
"description": "\nControls the appearance of dropdown icon as being an icon-only button. true renders the tertiary variant and\nfalse/undefined renders the default secondary appearance."
|
|
902
|
+
},
|
|
903
|
+
"headingTagVariant": {
|
|
904
|
+
"type": "string",
|
|
905
|
+
"values": [
|
|
906
|
+
"h1",
|
|
907
|
+
"h2",
|
|
908
|
+
"h3",
|
|
909
|
+
"h4",
|
|
910
|
+
"h5",
|
|
911
|
+
"h6"
|
|
912
|
+
],
|
|
913
|
+
"default": "h3",
|
|
914
|
+
"description": "\nPurely meant to help the user structure the HTML page hierarchy. Does not change the\nheader size. Defaults to 'h3'"
|
|
915
|
+
},
|
|
916
|
+
"brandHeader": {
|
|
917
|
+
"type": "boolean",
|
|
918
|
+
"description": "\nControls whether the header takes on the theme's 'brand-strong' color"
|
|
919
|
+
},
|
|
920
|
+
"accordionItemId": {
|
|
921
|
+
"type": "string",
|
|
922
|
+
"description": "\nOptional custom id for the accordion item, if one is not set, a random id is generated for you."
|
|
923
|
+
}
|
|
924
|
+
},
|
|
925
|
+
"slots": {
|
|
926
|
+
"default": {
|
|
927
|
+
"description": "The body of the accordion item will be any valid html\ninserted between the cre8-accordion-item opening and closing tags."
|
|
928
|
+
}
|
|
929
|
+
},
|
|
930
|
+
"events": {},
|
|
931
|
+
"cssProperties": {},
|
|
932
|
+
"examples": []
|
|
933
|
+
},
|
|
934
|
+
{
|
|
935
|
+
"name": "cre8-dropdown",
|
|
936
|
+
"category": "Disclosure",
|
|
937
|
+
"description": "The Dropdown menu itself is a container that can host multiple interactive items, commonly formatted as a list",
|
|
938
|
+
"attributes": {},
|
|
939
|
+
"properties": {
|
|
940
|
+
"buttonText": {
|
|
941
|
+
"type": "string",
|
|
942
|
+
"description": "Dropdown header"
|
|
943
|
+
},
|
|
944
|
+
"maxHeight": {
|
|
945
|
+
"type": "string",
|
|
946
|
+
"description": "Enables scrolling once content reached to specified height, the height should mention in px units, ex: 100px"
|
|
947
|
+
},
|
|
948
|
+
"dropdownWithLink": {
|
|
949
|
+
"type": "boolean",
|
|
950
|
+
"default": false,
|
|
951
|
+
"description": "button text represents as a link"
|
|
952
|
+
},
|
|
953
|
+
"open": {
|
|
954
|
+
"type": "boolean"
|
|
955
|
+
},
|
|
956
|
+
"dropdownContent": {
|
|
957
|
+
"type": "HTMLElement"
|
|
958
|
+
}
|
|
959
|
+
},
|
|
960
|
+
"slots": {},
|
|
961
|
+
"events": {},
|
|
962
|
+
"cssProperties": {},
|
|
963
|
+
"examples": []
|
|
964
|
+
},
|
|
965
|
+
{
|
|
966
|
+
"name": "cre8-dropdown-item",
|
|
967
|
+
"category": "Disclosure",
|
|
968
|
+
"description": "The Dropdown item component is designed to be used with Dropdown component, each item represents a\nselectable option or action within the dropdown menu. It can be configured to trigger actions, navigate\nto links, initiate commands when clicked.",
|
|
969
|
+
"attributes": {},
|
|
970
|
+
"properties": {
|
|
971
|
+
"ariaLabel": {
|
|
972
|
+
"type": "string"
|
|
973
|
+
}
|
|
974
|
+
},
|
|
975
|
+
"slots": {},
|
|
976
|
+
"events": {
|
|
977
|
+
"dropdown-item-selected": {
|
|
978
|
+
"detail": {}
|
|
979
|
+
}
|
|
980
|
+
},
|
|
981
|
+
"cssProperties": {},
|
|
982
|
+
"examples": []
|
|
983
|
+
},
|
|
984
|
+
{
|
|
985
|
+
"name": "cre8-modal",
|
|
986
|
+
"category": "Disclosure",
|
|
987
|
+
"description": "Modal component should be used in all modal situations.\nIt is natuarally composable and can even have a custom header and remove the close button.\n(note: adding `slot=\"header\"` will insert the given element into the header section of the modal,\nsame for `slot=\"footer\"` and no given slot name will inset it into the body)\n\nIf it is desired to create a utility modal. Cre8Modal requires a status value (see props table below,\nand a UtilityModalTitle since all utility modals have a cre8-heading)",
|
|
988
|
+
"attributes": {
|
|
989
|
+
"status": {
|
|
990
|
+
"type": "string",
|
|
991
|
+
"values": [
|
|
992
|
+
"error",
|
|
993
|
+
"info",
|
|
994
|
+
"warning",
|
|
995
|
+
"success",
|
|
996
|
+
"help"
|
|
997
|
+
],
|
|
998
|
+
"description": "Status Types\n<cre8-text-passage size=\"sm\">\n<ul>\n<li>**default (no value)** renders a default modal</li>\n<li>**error** renders an error modal</li>\n<li>**warning** renders a warning modal</li>\n<li>**success** renders a success modal</li>\n<li>**info** renders an info modal</li>\n<li>**help** renders an help modal</li>\n</ul>\n</cre8-text-passage>"
|
|
999
|
+
}
|
|
1000
|
+
},
|
|
1001
|
+
"properties": {
|
|
1002
|
+
"isActive": {
|
|
1003
|
+
"type": "boolean",
|
|
1004
|
+
"description": "Is Active attribute"
|
|
1005
|
+
},
|
|
1006
|
+
"utilityModalTitle": {
|
|
1007
|
+
"type": "string",
|
|
1008
|
+
"description": "Utility Modal Heading (String)"
|
|
1009
|
+
},
|
|
1010
|
+
"notDismissible": {
|
|
1011
|
+
"type": "boolean",
|
|
1012
|
+
"description": "Not dismissible modal"
|
|
1013
|
+
},
|
|
1014
|
+
"closeButtonText": {
|
|
1015
|
+
"type": "string",
|
|
1016
|
+
"default": "close",
|
|
1017
|
+
"description": "Close Button Text"
|
|
1018
|
+
},
|
|
1019
|
+
"closeButtonIcon": {
|
|
1020
|
+
"type": "string",
|
|
1021
|
+
"default": "close",
|
|
1022
|
+
"description": "Close Button Icon"
|
|
1023
|
+
},
|
|
1024
|
+
"ariaLabel": {
|
|
1025
|
+
"type": "string",
|
|
1026
|
+
"description": "Modal Aria Label - This is required for accessibility and provides context of the entire modal!"
|
|
1027
|
+
},
|
|
1028
|
+
"mapStatusToIconModal": {
|
|
1029
|
+
"type": "(status: string) => TemplateResult<1> | null",
|
|
1030
|
+
"description": "Maps modal icons and modal status variants to what the alt text of the related icon should be\nsee: (https://digital.#.com/patterns-and-Components/informational-display/alerts-and-notifications#query=alerts)\nthis provides the recommendated alt text of different statuses"
|
|
1031
|
+
}
|
|
1032
|
+
},
|
|
1033
|
+
"slots": {
|
|
1034
|
+
"default": {
|
|
1035
|
+
"description": "The component content"
|
|
1036
|
+
}
|
|
1037
|
+
},
|
|
1038
|
+
"events": {},
|
|
1039
|
+
"cssProperties": {},
|
|
1040
|
+
"examples": []
|
|
1041
|
+
},
|
|
1042
|
+
{
|
|
1043
|
+
"name": "cre8-popover",
|
|
1044
|
+
"category": "Disclosure",
|
|
1045
|
+
"description": "The Popover is for progressive disclosure of relevant content often hidden behind a help or info icon.\nIts content should be no longer than 3-4 lines in addition to a line of heading text and an optional button.",
|
|
1046
|
+
"attributes": {
|
|
1047
|
+
"heading": {
|
|
1048
|
+
"type": "string",
|
|
1049
|
+
"description": "The heading text that appears at the top of the popover panel. Should only be 2-3 lines max."
|
|
1050
|
+
},
|
|
1051
|
+
"position": {
|
|
1052
|
+
"type": "string",
|
|
1053
|
+
"description": "Positions the popover panel absolutely to the trigger\n- **default** positions the popover panel below the trigger\n- **top** positions the popover panel below the trigger\n- **left** positions the popover panel below the trigger\n- **right** positions the popover panel below the trigger"
|
|
1054
|
+
}
|
|
1055
|
+
},
|
|
1056
|
+
"properties": {
|
|
1057
|
+
"isVisibleOnScroll": {
|
|
1058
|
+
"type": "boolean",
|
|
1059
|
+
"description": "Set to prevent the popover panel from hiding on scroll"
|
|
1060
|
+
},
|
|
1061
|
+
"isDynamic": {
|
|
1062
|
+
"type": "boolean",
|
|
1063
|
+
"description": "The dynamic state for the popover\n- If true, the popover panel placement is determined by its position in the viewport\n- If false, the popover panel placement will be placed according to the position value"
|
|
1064
|
+
},
|
|
1065
|
+
"isActiveDynamic": {
|
|
1066
|
+
"type": "boolean",
|
|
1067
|
+
"description": "The dynamic active state\n_This property is dynamically set_"
|
|
1068
|
+
},
|
|
1069
|
+
"isActive": {
|
|
1070
|
+
"type": "boolean",
|
|
1071
|
+
"description": "The active state for the popover\n- If true, the popover panel is visible\n- If false, the popover panel is hidden\n\n_This property is dynamically set_"
|
|
1072
|
+
},
|
|
1073
|
+
"isRTL": {
|
|
1074
|
+
"type": "boolean",
|
|
1075
|
+
"description": "Query the document direction value\n<br/><br/> _*This property is dynamically set_"
|
|
1076
|
+
},
|
|
1077
|
+
"handleOnClickOutside": {
|
|
1078
|
+
"type": "(e: MouseEvent) => void",
|
|
1079
|
+
"description": "Handle click outside the component\n1. Close the show/hide popover panel on click outside\n2. If the popover panel is already closed then we don't care about outside clicks and we can bail early\n3. By the time a user clicks on the page the shadowRoot will almost certainly be\ndefined, but TypeScript isn't that trusting and sees this.shadowRoot as possibly\nundefined. To work around that we'll check that we have a shadowRoot (and a\nrendered .host) element here to appease the TypeScript compiler. This should never\nactually be shown or run for a human end user.\n4. Check to see if we clicked inside the active panel\n5. If the panel is active and we've clicked outside of the panel then it should be closed."
|
|
1080
|
+
},
|
|
1081
|
+
"removeActiveOnScroll": {
|
|
1082
|
+
"type": "() => void",
|
|
1083
|
+
"description": "Remove Active State on Scroll\n1. If a scroll event is fired and visibileOnScroll is not true, remove the active state\n2. If the popover height is less than the window height, then allow the active to remove on scroll"
|
|
1084
|
+
},
|
|
1085
|
+
"removeActive": {
|
|
1086
|
+
"type": "() => void",
|
|
1087
|
+
"description": "Remove Active State\n1. If a specific event is fired, remove the active state."
|
|
1088
|
+
}
|
|
1089
|
+
},
|
|
1090
|
+
"slots": {
|
|
1091
|
+
"default": {
|
|
1092
|
+
"description": "The component content"
|
|
1093
|
+
}
|
|
1094
|
+
},
|
|
1095
|
+
"events": {
|
|
1096
|
+
"open": {
|
|
1097
|
+
"detail": {}
|
|
1098
|
+
},
|
|
1099
|
+
"close": {
|
|
1100
|
+
"detail": {}
|
|
1101
|
+
}
|
|
1102
|
+
},
|
|
1103
|
+
"cssProperties": {},
|
|
1104
|
+
"examples": []
|
|
1105
|
+
},
|
|
1106
|
+
{
|
|
1107
|
+
"name": "cre8-submenu",
|
|
1108
|
+
"category": "Disclosure",
|
|
1109
|
+
"description": "Submenu component.",
|
|
1110
|
+
"attributes": {},
|
|
1111
|
+
"properties": {},
|
|
1112
|
+
"slots": {
|
|
1113
|
+
"default": {
|
|
1114
|
+
"description": "The component content"
|
|
1115
|
+
}
|
|
1116
|
+
},
|
|
1117
|
+
"events": {},
|
|
1118
|
+
"cssProperties": {},
|
|
1119
|
+
"examples": []
|
|
1120
|
+
},
|
|
1121
|
+
{
|
|
1122
|
+
"name": "cre8-submenu-item",
|
|
1123
|
+
"category": "Disclosure",
|
|
1124
|
+
"description": "Submenu Item component.",
|
|
1125
|
+
"attributes": {
|
|
1126
|
+
"href": {
|
|
1127
|
+
"type": "string",
|
|
1128
|
+
"description": "The link URL"
|
|
1129
|
+
}
|
|
1130
|
+
},
|
|
1131
|
+
"properties": {},
|
|
1132
|
+
"slots": {
|
|
1133
|
+
"default": {
|
|
1134
|
+
"description": "The component content"
|
|
1135
|
+
}
|
|
1136
|
+
},
|
|
1137
|
+
"events": {},
|
|
1138
|
+
"cssProperties": {},
|
|
1139
|
+
"examples": []
|
|
1140
|
+
},
|
|
1141
|
+
{
|
|
1142
|
+
"name": "cre8-tooltip",
|
|
1143
|
+
"category": "Disclosure",
|
|
1144
|
+
"description": "The purpose of tooltips is to provide a tip or hint about what a tool, icon, link, or other interaction does.\nIf you need to present a call to action with perhaps a button for the user to click, then use\n[Popover](/docs/cre8-components-popover--docs) instead.\n\n##Tooltip Styles\nThere are 4 alignment options for Tooltips: Top, Bottom, Right, and Left. Default placement is Bottom, below the\nelement it is describing. Top or Bottom alignment are the the preferred placement, particularly on screens that\nhave a more narrow viewport. Tooltips utilize Global styles and are not affected by brand themes.\n\n**With icon**\n- **iconRotateDegree** & **iconFlipDirection** props are optional.\n- They are used to set up the correct dirrection for icons, for example,\narrows, caret up or caret down.\n\n##Usability Considerations\nWith the exception of icons - which should always have alt text at a minimum - the UI should never rely on\nTooltips for clarity, especially because they are not always discovered by the user. If the user cannot\nintuitively understand the interface without Tooltips, the interface should be redesigned.\n\n##How to use\n- Use Tooltips to clarify the UI element the user is interacting with, not to add additional content on the page.\nAlso, do not simply restate content on the page, for example, the title of the field.\n- Tooltips should be short and to the point. Example: \"Click X to do X\" or \"Icon Description.\" If a succinct\ndescription is not possible, the interaction element should be redesigned.\n- In a mouse-driven UI, Tooltips are triggered on hover (mouseover) and dismissed (disappear)\nwhen the user mouses away from the element. In touch UIs, a Tooltip is triggered by tapping\nand holding an item. The Tooltip is displayed as long as the user continues to hold the element.\nTap and hold is a more advanced user behavior, and further reason for not relying on Tooltips.\nA novice user may never discover tap and hold for Tooltips.",
|
|
1145
|
+
"attributes": {
|
|
1146
|
+
"position": {
|
|
1147
|
+
"type": "string",
|
|
1148
|
+
"values": [
|
|
1149
|
+
"default",
|
|
1150
|
+
"top",
|
|
1151
|
+
"left",
|
|
1152
|
+
"right"
|
|
1153
|
+
],
|
|
1154
|
+
"description": "Positions the tooltip panel absolutely to the icon. Position overrides `isDynamic`."
|
|
1155
|
+
},
|
|
1156
|
+
"knockout": {
|
|
1157
|
+
"type": "boolean",
|
|
1158
|
+
"description": "The knockout variant for the tooltip"
|
|
1159
|
+
},
|
|
1160
|
+
"svg": {
|
|
1161
|
+
"type": "string",
|
|
1162
|
+
"description": "svg as a raw string\n- The icon is defined by this prop.\n- Pass in a raw svg as a String for using <cre8-icon>"
|
|
1163
|
+
}
|
|
1164
|
+
},
|
|
1165
|
+
"properties": {
|
|
1166
|
+
"isDynamic": {
|
|
1167
|
+
"type": "boolean",
|
|
1168
|
+
"description": "The dynamic state for the tooltip. Position overrides isDynamic."
|
|
1169
|
+
},
|
|
1170
|
+
"isActiveDynamic": {
|
|
1171
|
+
"type": "boolean",
|
|
1172
|
+
"description": "The dynamic active state"
|
|
1173
|
+
},
|
|
1174
|
+
"isActive": {
|
|
1175
|
+
"type": "boolean",
|
|
1176
|
+
"description": "The active state for the tooltip"
|
|
1177
|
+
},
|
|
1178
|
+
"ariaDescribes": {
|
|
1179
|
+
"type": "string",
|
|
1180
|
+
"description": "Accepts the ID string of the item the tooltip is referencing"
|
|
1181
|
+
},
|
|
1182
|
+
"iconRotateDegree": {
|
|
1183
|
+
"type": "number",
|
|
1184
|
+
"default": 0,
|
|
1185
|
+
"description": "iconRotateDegree is used for <cre8-icon> to set the arrow in the correct direction"
|
|
1186
|
+
},
|
|
1187
|
+
"iconFlipDirection": {
|
|
1188
|
+
"type": "string",
|
|
1189
|
+
"description": "iconFlipDirection is used for <cre8-icon> to set the icon in the correct direction"
|
|
1190
|
+
},
|
|
1191
|
+
"isRTL": {
|
|
1192
|
+
"type": "boolean",
|
|
1193
|
+
"description": "Query the document direction value\n<br/><br/> _*This property is dynamically set_"
|
|
1194
|
+
},
|
|
1195
|
+
"removeActive": {
|
|
1196
|
+
"type": "() => void",
|
|
1197
|
+
"description": "Remove Active State\n1. If a specific event is fired, remove the active state."
|
|
1198
|
+
}
|
|
1199
|
+
},
|
|
1200
|
+
"slots": {
|
|
1201
|
+
"default": {
|
|
1202
|
+
"description": "Default, unnamed slot container for Tooltip text"
|
|
1203
|
+
},
|
|
1204
|
+
"trigger": {
|
|
1205
|
+
"description": "Named slot container for Tooltip element to trigger showing/hiding the Tooltip text"
|
|
1206
|
+
}
|
|
1207
|
+
},
|
|
1208
|
+
"events": {
|
|
1209
|
+
"open": {
|
|
1210
|
+
"detail": {}
|
|
1211
|
+
},
|
|
1212
|
+
"close": {
|
|
1213
|
+
"detail": {}
|
|
1214
|
+
}
|
|
1215
|
+
},
|
|
1216
|
+
"cssProperties": {},
|
|
1217
|
+
"examples": []
|
|
1218
|
+
},
|
|
1219
|
+
{
|
|
1220
|
+
"name": "cre8-alert",
|
|
1221
|
+
"category": "Feedback",
|
|
1222
|
+
"description": "The general purpose of an alert or notification is to draw the user’s attention\nand provide the user with timely, relevant information.\n\n## Alert Styles:\n- There are 6 statuses for 6 types of alerts: 'error', 'info', 'notification', 'neutral', 'warning', 'success'.\nEach alert will have different icon to be displayed in the alert.\n- Users can select two types of alert variants: 'standalone', or 'banner'.\n- User can also choose the alert should be emphasized or not. There are two options: subtle or strong.\n- User can add button or link in the alert.\nIf users choose to emphasize the alert (**strong**), user needs to used **\"inverted\"** prop in button or link.\n- User can choose whether the alert can be dismissed or not",
|
|
1223
|
+
"attributes": {
|
|
1224
|
+
"status": {
|
|
1225
|
+
"type": "string",
|
|
1226
|
+
"values": [
|
|
1227
|
+
"error",
|
|
1228
|
+
"info",
|
|
1229
|
+
"notification",
|
|
1230
|
+
"neutral",
|
|
1231
|
+
"warning",
|
|
1232
|
+
"success"
|
|
1233
|
+
],
|
|
1234
|
+
"default": "info",
|
|
1235
|
+
"description": "The alert type."
|
|
1236
|
+
},
|
|
1237
|
+
"variant": {
|
|
1238
|
+
"type": "string",
|
|
1239
|
+
"values": [
|
|
1240
|
+
"standalone",
|
|
1241
|
+
"banner"
|
|
1242
|
+
],
|
|
1243
|
+
"default": "standalone",
|
|
1244
|
+
"description": "The alert variant."
|
|
1245
|
+
},
|
|
1246
|
+
"emphasis": {
|
|
1247
|
+
"type": "string",
|
|
1248
|
+
"values": [
|
|
1249
|
+
"subtle",
|
|
1250
|
+
"strong"
|
|
1251
|
+
],
|
|
1252
|
+
"default": "subtle"
|
|
1253
|
+
},
|
|
1254
|
+
"dismissed": {
|
|
1255
|
+
"type": "boolean",
|
|
1256
|
+
"description": "Dismissed property\n1) State that changes to true and is removed when the banner is dismissed"
|
|
1257
|
+
}
|
|
1258
|
+
},
|
|
1259
|
+
"properties": {
|
|
1260
|
+
"iconAlert": {
|
|
1261
|
+
"type": "string",
|
|
1262
|
+
"default": "undefined"
|
|
1263
|
+
},
|
|
1264
|
+
"iconTitle": {
|
|
1265
|
+
"type": "string",
|
|
1266
|
+
"description": "Icon title used for the icon alt text"
|
|
1267
|
+
},
|
|
1268
|
+
"headerText": {
|
|
1269
|
+
"type": "string",
|
|
1270
|
+
"default": "undefined"
|
|
1271
|
+
},
|
|
1272
|
+
"ctaBody": {
|
|
1273
|
+
"type": "string",
|
|
1274
|
+
"default": "undefined"
|
|
1275
|
+
},
|
|
1276
|
+
"notDismissible": {
|
|
1277
|
+
"type": "boolean",
|
|
1278
|
+
"description": "Dismissable property\n1) Adds the ability to close when toggled to true"
|
|
1279
|
+
}
|
|
1280
|
+
},
|
|
1281
|
+
"slots": {},
|
|
1282
|
+
"events": {},
|
|
1283
|
+
"cssProperties": {},
|
|
1284
|
+
"examples": [
|
|
1285
|
+
{
|
|
1286
|
+
"description": "Standalone alert",
|
|
1287
|
+
"html": "<cre8-alert variant=\"standalone\"></cre8-alert>"
|
|
1288
|
+
}
|
|
1289
|
+
]
|
|
1290
|
+
},
|
|
1291
|
+
{
|
|
1292
|
+
"name": "cre8-badge",
|
|
1293
|
+
"category": "Feedback",
|
|
1294
|
+
"description": "Status badges are used most often in tables or fat rows in a list.\nThese Components serve a contextual purpose and don't provide any functionality.\nBadges should be organized inside a dedicated table row communicating status such as pending, approved or rejected.",
|
|
1295
|
+
"attributes": {
|
|
1296
|
+
"text": {
|
|
1297
|
+
"type": "string",
|
|
1298
|
+
"default": "undefined",
|
|
1299
|
+
"description": "The badge text"
|
|
1300
|
+
},
|
|
1301
|
+
"status": {
|
|
1302
|
+
"type": "string",
|
|
1303
|
+
"description": "Status (a color variant prop)\n- **neutral** (default) renders a badge with a neutral state treatment\n- **success** renders a badge with success state treatment\n- **warning** renders a badge with warning state treatment\n- **error** renders a badge with error state treatment\n- **info** renders a badge with information state treatment\n- **attention** renders a badge with attention state treatment"
|
|
1304
|
+
},
|
|
1305
|
+
"variant": {
|
|
1306
|
+
"type": "string",
|
|
1307
|
+
"description": "Background Style Variant\n\n- **dark|undefined** (default) renders a badge with a dark background\n- **light** renders a badge with a light background\n- **white** renders a badge with a white background"
|
|
1308
|
+
},
|
|
1309
|
+
"svg": {
|
|
1310
|
+
"type": "string",
|
|
1311
|
+
"description": "SVG as a raw string\n- For badges with icons, the icon is defined by this prop\n- Pass in a raw svg as a String. We use raw string loader for this but any method of getting raw svgs will do\n- Import example:`import svgFeedback from '/Users/tylersmbp/Projects/cre8-web-components/packages/cre8-wc/icons/System/Regular/Feedback.svg?raw';`\n- [cre8-icons Github repo](https://git.express-scripts.com/ExpressScripts/cre8-icons) This is the Github\nrepo for Cre8 icons, which includes a link to the storybook as well as relavant information for new icons"
|
|
1312
|
+
}
|
|
1313
|
+
},
|
|
1314
|
+
"properties": {},
|
|
1315
|
+
"slots": {},
|
|
1316
|
+
"events": {},
|
|
1317
|
+
"cssProperties": {},
|
|
1318
|
+
"examples": []
|
|
1319
|
+
},
|
|
1320
|
+
{
|
|
1321
|
+
"name": "cre8-inline-alert",
|
|
1322
|
+
"category": "Feedback",
|
|
1323
|
+
"description": "In cases when it is necessary to alert the user but a less strong message that cannot be dismissed is desired,\nuse an in-line contextual alert message as the least \"severe\" message type.\nThese can be displayed anywhere on the page, but should never cover content.\nInline alerts do not include a title or close capability and are considered minimally intrusive user messaging.",
|
|
1324
|
+
"attributes": {
|
|
1325
|
+
"variant": {
|
|
1326
|
+
"type": "string",
|
|
1327
|
+
"values": [
|
|
1328
|
+
"subtle",
|
|
1329
|
+
"transparent"
|
|
1330
|
+
],
|
|
1331
|
+
"default": "subtle",
|
|
1332
|
+
"description": "Variant\n- **subtle** (default) renders an alert message in a padded container with a with a border and background color\n- **transparent** renders an alert message with no padded container, border, or background color"
|
|
1333
|
+
},
|
|
1334
|
+
"status": {
|
|
1335
|
+
"type": "string",
|
|
1336
|
+
"values": [
|
|
1337
|
+
"error",
|
|
1338
|
+
"info",
|
|
1339
|
+
"neutral",
|
|
1340
|
+
"warning",
|
|
1341
|
+
"success",
|
|
1342
|
+
"attention",
|
|
1343
|
+
"help"
|
|
1344
|
+
],
|
|
1345
|
+
"default": "info",
|
|
1346
|
+
"description": "Status\n- **default** renders an inline alert with the brand colors\n- **error** renders an inline alert with an error state\n- **warning** renders an inline alert with a warning state\n- **success** renders an inline alert with a success state\n- **attention** renders an inline alert with an attention state\n- **neutral** renders an inline alert with a nuetral state"
|
|
1347
|
+
}
|
|
1348
|
+
},
|
|
1349
|
+
"properties": {
|
|
1350
|
+
"iconName": {
|
|
1351
|
+
"type": "string",
|
|
1352
|
+
"description": "DEPRECATED: Icon name used for the icon before to the field note"
|
|
1353
|
+
},
|
|
1354
|
+
"fullWidth": {
|
|
1355
|
+
"type": "boolean",
|
|
1356
|
+
"description": "Full width Inline Alert"
|
|
1357
|
+
},
|
|
1358
|
+
"iconTitle": {
|
|
1359
|
+
"type": "string",
|
|
1360
|
+
"description": "Icon title used for the icon alt text"
|
|
1361
|
+
}
|
|
1362
|
+
},
|
|
1363
|
+
"slots": {
|
|
1364
|
+
"default": {
|
|
1365
|
+
"description": "The component content"
|
|
1366
|
+
}
|
|
1367
|
+
},
|
|
1368
|
+
"events": {},
|
|
1369
|
+
"cssProperties": {},
|
|
1370
|
+
"examples": [
|
|
1371
|
+
{
|
|
1372
|
+
"description": "Subtle inline-alert",
|
|
1373
|
+
"html": "<cre8-inline-alert variant=\"subtle\"></cre8-inline-alert>"
|
|
1374
|
+
}
|
|
1375
|
+
]
|
|
1376
|
+
},
|
|
1377
|
+
{
|
|
1378
|
+
"name": "cre8-loading-spinner",
|
|
1379
|
+
"category": "Feedback",
|
|
1380
|
+
"description": "A loading spinner notifies the user that their request is being processed while the front end is retrieving data\nor performing slow computations.\n\nProviding visibility of a system's status is one of the most important rules of UI design. When the user has to\nguess or assume that the system is responding to their input, they may send a command such as submit multiple\ntimes, while also being anxious that the application is frozen or not working.\n\nWhile it is most ideal to improve system performance such that there is no perceptible delay, in some cases this\nis not possible. In these cases, the immediate response should be a progress indicator to give a visual indication\nthat their command was received and that the application is working.\n\nThe length of time for the system response is a good general guideline for which progress indicator to use.\n\n## Determinable vs indeterminate progress\n\nA progress meter provides feedback that the system is working and gives the user an indication of how much time\nthey will wait. This indicator should be used when the system response time is longer and determinable. See\nProgressMeter component for further examples and accessibility considerations.\n\n## How to Use\n\nThe loading-spinner component can be used to indicate loading state on the component level all the way up to the\npage level. There are two loading styles: determinate (loading progress represents percentage of total load time)\nand indeterminate (a spinning animation that persists while loading continues)\n\n1. Choose determinate or indeterminate. UX best practices leans more towards recommending the indeterminate\nprogress indicator if load time is unknown, while determinate is less user friendly unless the label indicates\nthe percentage loaded as well.\n2. Choose a size and use it according to context, guidance should be given by your design or content team.\n3. A common label to use is `Loading…`, guidance should be given by your design content team.\n4. If you choose to use the determinate loader then you must also control the progress attribute's value which\ncontrols the percentage of the circle that shows (values 0-100 accepted);\n5. For dark backgrounds, add the `inverse` attribute to the `<cre8-loading-spinner>` tag.\n6. For accessibility reasons, always include a label input unless explicitly informed to do otherwise by design or\naccessibility teams.\n7. The lg variant is usually suitable for containers or block level loading placeholders while the sm size is\nmeant for more inline loading states.",
|
|
1381
|
+
"attributes": {
|
|
1382
|
+
"determinate": {
|
|
1383
|
+
"type": "boolean",
|
|
1384
|
+
"description": "Mode of the spinner, defaults to indeterminate.\nIf true, renders a standard progress indicator, fills via the progress property from 0% to 100%.\nIf false or undefined, renders indeterminate spinner which animates in a spinning motion until component is\ndestroyed."
|
|
1385
|
+
},
|
|
1386
|
+
"inverse": {
|
|
1387
|
+
"type": "boolean",
|
|
1388
|
+
"description": "Inverse property used for dark backgrounds."
|
|
1389
|
+
},
|
|
1390
|
+
"neutral": {
|
|
1391
|
+
"type": "boolean",
|
|
1392
|
+
"description": "Neutral property used for secondary neutral loading button."
|
|
1393
|
+
},
|
|
1394
|
+
"label": {
|
|
1395
|
+
"type": "string",
|
|
1396
|
+
"description": "Label to show along with progress indicator.\nThis is required to meet accessibility requirements for this component."
|
|
1397
|
+
},
|
|
1398
|
+
"progress": {
|
|
1399
|
+
"type": "number",
|
|
1400
|
+
"default": 0,
|
|
1401
|
+
"description": "Progress to display, between 0 and 100. Requires determinate property to be set to true."
|
|
1402
|
+
},
|
|
1403
|
+
"size": {
|
|
1404
|
+
"type": "string",
|
|
1405
|
+
"values": [
|
|
1406
|
+
"large",
|
|
1407
|
+
"small"
|
|
1408
|
+
],
|
|
1409
|
+
"default": "large",
|
|
1410
|
+
"description": "Size of the progress indicator and position of the label, if a label has been defined using the label property.\n- **large** renders a large progress indicator at 72px in width/height with the label below.\n- **small** renders a small progress indicator at 24px in width/height with the label to the right."
|
|
1411
|
+
}
|
|
1412
|
+
},
|
|
1413
|
+
"properties": {
|
|
1414
|
+
"buttonVariant": {
|
|
1415
|
+
"type": "string",
|
|
1416
|
+
"values": [
|
|
1417
|
+
"primary",
|
|
1418
|
+
"secondary",
|
|
1419
|
+
"tertiary"
|
|
1420
|
+
],
|
|
1421
|
+
"description": "Property that specifies which button variant is using the loading spinner"
|
|
1422
|
+
}
|
|
1423
|
+
},
|
|
1424
|
+
"slots": {},
|
|
1425
|
+
"events": {},
|
|
1426
|
+
"cssProperties": {},
|
|
1427
|
+
"examples": []
|
|
1428
|
+
},
|
|
1429
|
+
{
|
|
1430
|
+
"name": "cre8-percent-bar",
|
|
1431
|
+
"category": "Feedback",
|
|
1432
|
+
"description": "The percent bar visually indicates a user's current progress and has a few features: a basic display bar with\na percentage, an actionable icon that allows a user to revisit a prior step and an actionable link that\nallows a user save their progress before exiting.",
|
|
1433
|
+
"attributes": {
|
|
1434
|
+
"value": {
|
|
1435
|
+
"type": "number",
|
|
1436
|
+
"description": "The current step the user is on."
|
|
1437
|
+
},
|
|
1438
|
+
"max": {
|
|
1439
|
+
"type": "number",
|
|
1440
|
+
"description": "The total number of steps in the multistep process."
|
|
1441
|
+
}
|
|
1442
|
+
},
|
|
1443
|
+
"properties": {
|
|
1444
|
+
"disableActionLeft": {
|
|
1445
|
+
"type": "boolean",
|
|
1446
|
+
"description": "The action-left icon-only tertiary button in the percent bar controls can be disabled."
|
|
1447
|
+
}
|
|
1448
|
+
},
|
|
1449
|
+
"slots": {},
|
|
1450
|
+
"events": {
|
|
1451
|
+
"leftActionButtonClick": {
|
|
1452
|
+
"detail": {}
|
|
1453
|
+
}
|
|
1454
|
+
},
|
|
1455
|
+
"cssProperties": {},
|
|
1456
|
+
"examples": []
|
|
1457
|
+
},
|
|
1458
|
+
{
|
|
1459
|
+
"name": "cre8-progress-meter",
|
|
1460
|
+
"category": "Feedback",
|
|
1461
|
+
"description": "A progress meter provides feedback that the system is working and gives\nthe user an indication of how much time they will wait.\nThis indicator should be used when the system response time is longer and determinable.",
|
|
1462
|
+
"attributes": {
|
|
1463
|
+
"status": {
|
|
1464
|
+
"type": "status",
|
|
1465
|
+
"description": "Progress Status\n- **Default** renders a meter with default status fill\n- **Error** renders a meter with an error status fill\n- **Warning** renders a meter with a warning status\n- **Success** renders a meter with a success status fill"
|
|
1466
|
+
},
|
|
1467
|
+
"knockout": {
|
|
1468
|
+
"type": "boolean",
|
|
1469
|
+
"description": "Determines if the progress meter is displayed on a dark background (uses knockout colors for contrast)"
|
|
1470
|
+
},
|
|
1471
|
+
"max": {
|
|
1472
|
+
"type": "number",
|
|
1473
|
+
"default": 100,
|
|
1474
|
+
"description": "The max number for the progress bar (defaulted to 100 to match percentages)"
|
|
1475
|
+
},
|
|
1476
|
+
"value": {
|
|
1477
|
+
"type": "number",
|
|
1478
|
+
"description": "The the percentage of the bar that is filled in (defaulted to match percentages)\nI.E a value of 50 with a 100 max would result in half the meter being filled"
|
|
1479
|
+
},
|
|
1480
|
+
"name": {
|
|
1481
|
+
"type": "string",
|
|
1482
|
+
"description": "Progress Meter name"
|
|
1483
|
+
},
|
|
1484
|
+
"label": {
|
|
1485
|
+
"type": "string",
|
|
1486
|
+
"description": "Progress Meter label"
|
|
1487
|
+
}
|
|
1488
|
+
},
|
|
1489
|
+
"properties": {
|
|
1490
|
+
"fieldId": {
|
|
1491
|
+
"type": "string",
|
|
1492
|
+
"description": "Progress Meter FieldId"
|
|
1493
|
+
}
|
|
1494
|
+
},
|
|
1495
|
+
"slots": {},
|
|
1496
|
+
"events": {},
|
|
1497
|
+
"cssProperties": {},
|
|
1498
|
+
"examples": []
|
|
1499
|
+
},
|
|
1500
|
+
{
|
|
1501
|
+
"name": "cre8-progress-steps-item",
|
|
1502
|
+
"category": "Feedback",
|
|
1503
|
+
"description": "The Progress Steps Item component is used to display a single step in a multi-step process.\nIt should be used as a child component of `cre8-progress-steps`.\nThese Components serve a contextual purpose and don't provide any functionality.",
|
|
1504
|
+
"attributes": {
|
|
1505
|
+
"message": {
|
|
1506
|
+
"type": "string",
|
|
1507
|
+
"description": "Optional message to display under the step name."
|
|
1508
|
+
},
|
|
1509
|
+
"name": {
|
|
1510
|
+
"type": "string",
|
|
1511
|
+
"description": "The name of the step."
|
|
1512
|
+
},
|
|
1513
|
+
"state": {
|
|
1514
|
+
"type": "string",
|
|
1515
|
+
"description": "The state of the step: 'complete', 'current', 'error',' incomplete', 'warning';"
|
|
1516
|
+
},
|
|
1517
|
+
"svg": {
|
|
1518
|
+
"type": "string",
|
|
1519
|
+
"description": "An SVG string to use as the step icon."
|
|
1520
|
+
}
|
|
1521
|
+
},
|
|
1522
|
+
"properties": {},
|
|
1523
|
+
"slots": {
|
|
1524
|
+
"default": {
|
|
1525
|
+
"description": "The component content"
|
|
1526
|
+
}
|
|
1527
|
+
},
|
|
1528
|
+
"events": {},
|
|
1529
|
+
"cssProperties": {},
|
|
1530
|
+
"examples": []
|
|
1531
|
+
},
|
|
1532
|
+
{
|
|
1533
|
+
"name": "cre8-skeleton-loader",
|
|
1534
|
+
"category": "Feedback",
|
|
1535
|
+
"description": "Skeleton Loader allows for the ability to create placeholder UI loading states.\nDevelopers are encouraged to pass into the Skeleton Loader their own parameters\nto create simple (or complex) loading screens.\n\n## How to Use\nSkeleton states are simplified versions of components used on an initial page load\nto indicate that the information on the page has not fully loaded yet.\nThey only appear for only a few seconds, disappearing once components and content populate the page.\nThese loaders use motion to convey that the page is not stuck and that data is still being loaded.\nThis can help to reduce user uncertainty. Skeleton objects should generally be visualized\nby simple primitives which mimic the original content in a recognizable way.\nIt is recommended to use a more elaborate form if that is needed to make the component recognizable.\n\nNever represent toast notifications, overflow menus, dropdown items, modals, and loaders with skeleton states.\nElements inside a modal may have a skeleton state, but the modal itself should not.\n\n**IMPORTANT!** This is not a loading element and will provide no value to a screen reader user,\nthis is a decorative element only!",
|
|
1536
|
+
"attributes": {
|
|
1537
|
+
"variant": {
|
|
1538
|
+
"type": "string",
|
|
1539
|
+
"values": [
|
|
1540
|
+
"rectangle",
|
|
1541
|
+
"square",
|
|
1542
|
+
"circle"
|
|
1543
|
+
],
|
|
1544
|
+
"default": "rectangle",
|
|
1545
|
+
"description": "Style variant\n- **rectangle** renders a featureless rectangle as a placeholder for loading elements\n- **square** renders a featureless square as a placeholder for loading elements\n- **circle** renders a featureless circle as a placeholder for loading elements"
|
|
1546
|
+
},
|
|
1547
|
+
"height": {
|
|
1548
|
+
"type": "string",
|
|
1549
|
+
"description": "Height inline style\n1. Used to set a height on the skeleton if specific size is needed"
|
|
1550
|
+
},
|
|
1551
|
+
"width": {
|
|
1552
|
+
"type": "string",
|
|
1553
|
+
"description": "Width inline style\n1. Used to set a width on the skeleton if specific size is needed"
|
|
1554
|
+
}
|
|
1555
|
+
},
|
|
1556
|
+
"properties": {},
|
|
1557
|
+
"slots": {},
|
|
1558
|
+
"events": {},
|
|
1559
|
+
"cssProperties": {},
|
|
1560
|
+
"examples": [
|
|
1561
|
+
{
|
|
1562
|
+
"description": "Rectangle skeleton-loader",
|
|
1563
|
+
"html": "<cre8-skeleton-loader variant=\"rectangle\"></cre8-skeleton-loader>"
|
|
1564
|
+
}
|
|
1565
|
+
]
|
|
1566
|
+
},
|
|
1567
|
+
{
|
|
1568
|
+
"name": "cre8-checkbox-field",
|
|
1569
|
+
"category": "Forms",
|
|
1570
|
+
"description": "Checkbox Field is the parent container for `checkbox-field-item`.\nIt is required to allow for grouping numerous checkboxes that need additional context (in the form of `<legend>`).\nIt also provides accessibility roles, aria attributes and field note messaging on the group.\n\nSee `checkbox-field-item` for more guidance on its usage.",
|
|
1571
|
+
"attributes": {
|
|
1572
|
+
"label": {
|
|
1573
|
+
"type": "string",
|
|
1574
|
+
"description": "Checkbox container legend label"
|
|
1575
|
+
}
|
|
1576
|
+
},
|
|
1577
|
+
"properties": {
|
|
1578
|
+
"fieldNote": {
|
|
1579
|
+
"type": "string",
|
|
1580
|
+
"description": "Checkbox container fieldnote"
|
|
1581
|
+
},
|
|
1582
|
+
"ariaDescribedBy": {
|
|
1583
|
+
"type": "string",
|
|
1584
|
+
"description": "Checkbox container fieldnote aria describe by"
|
|
1585
|
+
},
|
|
1586
|
+
"fieldNoteIconName": {
|
|
1587
|
+
"type": "string",
|
|
1588
|
+
"description": "Checkbox container fieldnote icon name"
|
|
1589
|
+
},
|
|
1590
|
+
"fieldNoteKnockout": {
|
|
1591
|
+
"type": "boolean",
|
|
1592
|
+
"description": "Checkbox container fieldnote knockout"
|
|
1593
|
+
},
|
|
1594
|
+
"fieldNoteIsSuccess": {
|
|
1595
|
+
"type": "boolean",
|
|
1596
|
+
"description": "Checkbox container fieldnote isSuccess"
|
|
1597
|
+
},
|
|
1598
|
+
"fieldNoteIsError": {
|
|
1599
|
+
"type": "boolean",
|
|
1600
|
+
"description": "Checkbox container fieldnote isError"
|
|
1601
|
+
}
|
|
1602
|
+
},
|
|
1603
|
+
"slots": {
|
|
1604
|
+
"default": {
|
|
1605
|
+
"description": "The component content, which should be a set of `checkbox-field-item`s"
|
|
1606
|
+
}
|
|
1607
|
+
},
|
|
1608
|
+
"events": {},
|
|
1609
|
+
"cssProperties": {},
|
|
1610
|
+
"examples": []
|
|
1611
|
+
},
|
|
1612
|
+
{
|
|
1613
|
+
"name": "cre8-checkbox-field-item",
|
|
1614
|
+
"category": "Forms",
|
|
1615
|
+
"description": "Checkbox Field Item is the combination of a checkbox input, label and field note.\nCheckboxes can turn an option on or off.\n\nCheckboxes should be used when the user is allowed to select one, none or multiple options\nOR to \"opt-in\" (ex. I would like to receive the newsletter by email)\nor as a required acknowledgement(ex. I've read the Terms and Conditions).\nIf the user can only chose one option from many, use `radio-field-item`.\n\n## How to Use\n\n- A checkbox is independent of all other checkboxes in the list,\n so checking one box should not uncheck the others in the group.\n- Place checkbox options one on top of another vertically. Do not display them in a row horizontally.\n- Avoid disabled and read-only states as much as possible.\n\n## Universal Form Field Rules\n- Unless indicated with the \"(Optional)\" label, all fields are assumed required.\n Minimize the number of optional fields to keep forms as short as possible.\n- Always include a label written in sentence case.\n- Avoid using the read-only and disabled states as much as possible.",
|
|
1616
|
+
"attributes": {
|
|
1617
|
+
"label": {
|
|
1618
|
+
"type": "string",
|
|
1619
|
+
"description": "The checkbox label"
|
|
1620
|
+
},
|
|
1621
|
+
"checked": {
|
|
1622
|
+
"type": "boolean",
|
|
1623
|
+
"description": "Checked State"
|
|
1624
|
+
},
|
|
1625
|
+
"name": {
|
|
1626
|
+
"type": "string",
|
|
1627
|
+
"description": "The name of the form field"
|
|
1628
|
+
},
|
|
1629
|
+
"disabled": {
|
|
1630
|
+
"type": "boolean",
|
|
1631
|
+
"description": "Disabled State"
|
|
1632
|
+
},
|
|
1633
|
+
"required": {
|
|
1634
|
+
"type": "boolean",
|
|
1635
|
+
"description": "Required property"
|
|
1636
|
+
},
|
|
1637
|
+
"value": {
|
|
1638
|
+
"type": "string",
|
|
1639
|
+
"description": "The value of the form field."
|
|
1640
|
+
}
|
|
1641
|
+
},
|
|
1642
|
+
"properties": {
|
|
1643
|
+
"errorText": {
|
|
1644
|
+
"type": "string",
|
|
1645
|
+
"default": "Error",
|
|
1646
|
+
"description": "Visually hidden text that always signifies that this is an error for screen reader usage"
|
|
1647
|
+
},
|
|
1648
|
+
"errorNote": {
|
|
1649
|
+
"type": "string",
|
|
1650
|
+
"description": "The error field note that appears below the default field note"
|
|
1651
|
+
},
|
|
1652
|
+
"successText": {
|
|
1653
|
+
"type": "string",
|
|
1654
|
+
"default": "Success",
|
|
1655
|
+
"description": "Visually hidden text that always signifies that this is successful for screen reader usage"
|
|
1656
|
+
},
|
|
1657
|
+
"successNote": {
|
|
1658
|
+
"type": "string",
|
|
1659
|
+
"description": "The success field note that appears below the default field note"
|
|
1660
|
+
},
|
|
1661
|
+
"fieldId": {
|
|
1662
|
+
"type": "string",
|
|
1663
|
+
"description": "Checkbox FieldId"
|
|
1664
|
+
},
|
|
1665
|
+
"fieldNote": {
|
|
1666
|
+
"type": "string",
|
|
1667
|
+
"description": "Checkbox FieldNote"
|
|
1668
|
+
},
|
|
1669
|
+
"ariaDescribedBy": {
|
|
1670
|
+
"type": "string",
|
|
1671
|
+
"description": "Checkbox fieldnote ariaDescribeBy"
|
|
1672
|
+
},
|
|
1673
|
+
"validationAriaDescribedBy": {
|
|
1674
|
+
"type": "string",
|
|
1675
|
+
"description": "Additional aria-describedby connection to id for additional success and error notes to be accessible"
|
|
1676
|
+
},
|
|
1677
|
+
"fieldNoteIconName": {
|
|
1678
|
+
"type": "string",
|
|
1679
|
+
"description": "Checkbox fieldnote icon name"
|
|
1680
|
+
},
|
|
1681
|
+
"isError": {
|
|
1682
|
+
"type": "boolean",
|
|
1683
|
+
"description": "Changes the component's treatment to represent an error state"
|
|
1684
|
+
},
|
|
1685
|
+
"isSuccess": {
|
|
1686
|
+
"type": "boolean",
|
|
1687
|
+
"description": "Changes the component's treatment to represent a success state"
|
|
1688
|
+
},
|
|
1689
|
+
"type": {
|
|
1690
|
+
"type": "\"checkbox\"",
|
|
1691
|
+
"description": "The type of form control (text, checkbox, radio, etc.)"
|
|
1692
|
+
}
|
|
1693
|
+
},
|
|
1694
|
+
"slots": {},
|
|
1695
|
+
"events": {
|
|
1696
|
+
"change": {
|
|
1697
|
+
"detail": {}
|
|
1698
|
+
}
|
|
1699
|
+
},
|
|
1700
|
+
"cssProperties": {},
|
|
1701
|
+
"examples": []
|
|
1702
|
+
},
|
|
1703
|
+
{
|
|
1704
|
+
"name": "cre8-date-picker",
|
|
1705
|
+
"category": "Forms",
|
|
1706
|
+
"description": "The Date Picker component renders a form group with label, control, help text and validation styling much\nlike the Field component but exclusively for type=date.\nCre8DatePicker inherits the Cre8Field component.",
|
|
1707
|
+
"attributes": {
|
|
1708
|
+
"autocomplete": {
|
|
1709
|
+
"type": "string",
|
|
1710
|
+
"description": "Autocomplete attribute that allows input to expect certain types of information. Note: autocomplete is supported\nby most browsers, but the suggested 'completions' are also sourced from those browsers. Values come\nfrom past user stored data from past interactions in that browser, such as:\n\n 1. From past values entered by the user, but they may also come from pre-configured values. For\n instance, a browser might let the user save their name, address, phone number, and email addresses for\n autocomplete purposes.\n\n 2. Perhaps the browser offers the ability to save encrypted credit card information, for autocompletion\n following a an authentication procedure.\n See: [MDN web docs_](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete)\n\n NOTE:: In order to provide autocompletion, user-agents might require input, select, textarea\n elements to:\n\n 1. Have a {{name}} and/or {{id}} attribute\n 2. Be descendants of a form element\n 3. The form to have a [submit button](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/submit)"
|
|
1711
|
+
},
|
|
1712
|
+
"pattern": {
|
|
1713
|
+
"type": "string",
|
|
1714
|
+
"description": "Pattern attribute defines a regular expression to validate against input"
|
|
1715
|
+
},
|
|
1716
|
+
"placeholder": {
|
|
1717
|
+
"type": "string",
|
|
1718
|
+
"description": "The placeholder text that appears inside the input"
|
|
1719
|
+
},
|
|
1720
|
+
"label": {
|
|
1721
|
+
"type": "string",
|
|
1722
|
+
"default": "Label",
|
|
1723
|
+
"description": "The required label that appears above the input"
|
|
1724
|
+
},
|
|
1725
|
+
"max": {
|
|
1726
|
+
"type": "string | number",
|
|
1727
|
+
"description": "The max attribute defines the maximum value that is acceptable and valid for the input containing the attribute."
|
|
1728
|
+
},
|
|
1729
|
+
"min": {
|
|
1730
|
+
"type": "string | number",
|
|
1731
|
+
"description": "The min attribute defines the minimum value that is acceptable and valid for the input containing the attribute."
|
|
1732
|
+
},
|
|
1733
|
+
"maxlength": {
|
|
1734
|
+
"type": "string",
|
|
1735
|
+
"description": "The maxlength is an integer above 0 that indicates the maximum allowed characters to be entered. When using the\nmaxlength prop, you must also use the \"required\" prop to provide Constraint Validation on the input field.\nThis allows users to know why the input they attempted didn't render in the input field. see\n[MDN maxlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/maxlength#constraint_validation)"
|
|
1736
|
+
},
|
|
1737
|
+
"readonly": {
|
|
1738
|
+
"type": "boolean",
|
|
1739
|
+
"description": "Readonly attribute"
|
|
1740
|
+
},
|
|
1741
|
+
"type": {
|
|
1742
|
+
"type": "string",
|
|
1743
|
+
"default": "date",
|
|
1744
|
+
"description": "The type of the form field.\nFor Date Picker, this is always 'date'."
|
|
1745
|
+
},
|
|
1746
|
+
"name": {
|
|
1747
|
+
"type": "string",
|
|
1748
|
+
"description": "The name of the form field"
|
|
1749
|
+
},
|
|
1750
|
+
"disabled": {
|
|
1751
|
+
"type": "boolean",
|
|
1752
|
+
"description": "The disabled attribute on the input"
|
|
1753
|
+
},
|
|
1754
|
+
"required": {
|
|
1755
|
+
"type": "boolean",
|
|
1756
|
+
"description": "The required attribute on the input"
|
|
1757
|
+
},
|
|
1758
|
+
"value": {
|
|
1759
|
+
"type": "string",
|
|
1760
|
+
"description": "The value of the form field."
|
|
1761
|
+
}
|
|
1762
|
+
},
|
|
1763
|
+
"properties": {
|
|
1764
|
+
"hasShortcuts": {
|
|
1765
|
+
"type": "boolean",
|
|
1766
|
+
"description": "Quick Shortcuts Variant"
|
|
1767
|
+
},
|
|
1768
|
+
"fieldId": {
|
|
1769
|
+
"type": "string",
|
|
1770
|
+
"description": "The unique id of the field\n<br/><br/> _*This property is dynamically set_"
|
|
1771
|
+
},
|
|
1772
|
+
"fieldNote": {
|
|
1773
|
+
"type": "string",
|
|
1774
|
+
"description": "The text that displays below in text field input"
|
|
1775
|
+
},
|
|
1776
|
+
"ariaLive": {
|
|
1777
|
+
"type": "string",
|
|
1778
|
+
"values": [
|
|
1779
|
+
"polite",
|
|
1780
|
+
"assertive"
|
|
1781
|
+
],
|
|
1782
|
+
"default": "polite",
|
|
1783
|
+
"description": "Controls how the voiceover will experience the new information when field note changes,\nimmediately (used for more urgently needed updates) using `assertive` or at the next convenient\npause in their navigation using `polite`."
|
|
1784
|
+
},
|
|
1785
|
+
"ariaDescribedBy": {
|
|
1786
|
+
"type": "string",
|
|
1787
|
+
"description": "Used to connect the field note in text field to the text menu for accessibility"
|
|
1788
|
+
},
|
|
1789
|
+
"errorText": {
|
|
1790
|
+
"type": "string",
|
|
1791
|
+
"default": "Error",
|
|
1792
|
+
"description": "Visually hidden text that always signifies that this is an error for screen reader usage"
|
|
1793
|
+
},
|
|
1794
|
+
"errorNote": {
|
|
1795
|
+
"type": "string",
|
|
1796
|
+
"description": "The error field note that appears below the default field note"
|
|
1797
|
+
},
|
|
1798
|
+
"validationAriaDescribedBy": {
|
|
1799
|
+
"type": "string",
|
|
1800
|
+
"description": "Additional aria-describedby connection to id for additional success and error notes to be accessible"
|
|
1801
|
+
},
|
|
1802
|
+
"successText": {
|
|
1803
|
+
"type": "string",
|
|
1804
|
+
"default": "Success",
|
|
1805
|
+
"description": "Visually hidden text that always signifies that this is successful for screen reader usage"
|
|
1806
|
+
},
|
|
1807
|
+
"successNote": {
|
|
1808
|
+
"type": "string",
|
|
1809
|
+
"description": "The success field note that appears below the default field note"
|
|
1810
|
+
},
|
|
1811
|
+
"isError": {
|
|
1812
|
+
"type": "boolean",
|
|
1813
|
+
"description": "Changes the component's treatment to represent an error state"
|
|
1814
|
+
},
|
|
1815
|
+
"isSuccess": {
|
|
1816
|
+
"type": "boolean",
|
|
1817
|
+
"description": "Changes the component's treatment to represent a success state"
|
|
1818
|
+
},
|
|
1819
|
+
"showCalendar": {
|
|
1820
|
+
"type": "boolean"
|
|
1821
|
+
}
|
|
1822
|
+
},
|
|
1823
|
+
"slots": {},
|
|
1824
|
+
"events": {},
|
|
1825
|
+
"cssProperties": {},
|
|
1826
|
+
"examples": []
|
|
1827
|
+
},
|
|
1828
|
+
{
|
|
1829
|
+
"name": "cre8-field",
|
|
1830
|
+
"category": "Forms",
|
|
1831
|
+
"description": "The Field component renders a form group with label, control, help text and validation styling. There are\nconvenience variants of Field to support HTML5 input types and static content.",
|
|
1832
|
+
"attributes": {
|
|
1833
|
+
"autocomplete": {
|
|
1834
|
+
"type": "string",
|
|
1835
|
+
"description": "Autocomplete attribute that allows input to expect certain types of information. Note: autocomplete is supported\nby most browsers, but the suggested 'completions' are also sourced from those browsers. Values come\nfrom past user stored data from past interactions in that browser, such as:\n\n 1. From past values entered by the user, but they may also come from pre-configured values. For\n instance, a browser might let the user save their name, address, phone number, and email addresses for\n autocomplete purposes.\n\n 2. Perhaps the browser offers the ability to save encrypted credit card information, for autocompletion\n following a an authentication procedure.\n See: [MDN web docs_](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete)\n\n NOTE:: In order to provide autocompletion, user-agents might require input, select, textarea\n elements to:\n\n 1. Have a {{name}} and/or {{id}} attribute\n 2. Be descendants of a form element\n 3. The form to have a [submit button](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/submit)"
|
|
1836
|
+
},
|
|
1837
|
+
"pattern": {
|
|
1838
|
+
"type": "string",
|
|
1839
|
+
"description": "Pattern attribute defines a regular expression to validate against input"
|
|
1840
|
+
},
|
|
1841
|
+
"placeholder": {
|
|
1842
|
+
"type": "string",
|
|
1843
|
+
"description": "The placeholder text that appears inside the input"
|
|
1844
|
+
},
|
|
1845
|
+
"label": {
|
|
1846
|
+
"type": "string",
|
|
1847
|
+
"default": "Label",
|
|
1848
|
+
"description": "The required label that appears above the input"
|
|
1849
|
+
},
|
|
1850
|
+
"max": {
|
|
1851
|
+
"type": "string | number",
|
|
1852
|
+
"description": "The max attribute defines the maximum value that is acceptable and valid for the input containing the attribute."
|
|
1853
|
+
},
|
|
1854
|
+
"min": {
|
|
1855
|
+
"type": "string | number",
|
|
1856
|
+
"description": "The min attribute defines the minimum value that is acceptable and valid for the input containing the attribute."
|
|
1857
|
+
},
|
|
1858
|
+
"maxlength": {
|
|
1859
|
+
"type": "string",
|
|
1860
|
+
"description": "The maxlength is an integer above 0 that indicates the maximum allowed characters to be entered. When using the\nmaxlength prop, you must also use the \"required\" prop to provide Constraint Validation on the input field.\nThis allows users to know why the input they attempted didn't render in the input field. see\n[MDN maxlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/maxlength#constraint_validation)"
|
|
1861
|
+
},
|
|
1862
|
+
"readonly": {
|
|
1863
|
+
"type": "boolean",
|
|
1864
|
+
"description": "Readonly attribute"
|
|
1865
|
+
},
|
|
1866
|
+
"type": {
|
|
1867
|
+
"type": "string",
|
|
1868
|
+
"default": "text",
|
|
1869
|
+
"description": "Type variants\n- **text** renders a standard text input\n- **email** renders a text input for an email format\n- **number** renders an input for number values only\n- **url** renders an input for urls only\n- **tel** renders an input for telephone number values only"
|
|
1870
|
+
},
|
|
1871
|
+
"name": {
|
|
1872
|
+
"type": "string",
|
|
1873
|
+
"description": "The name of the form field"
|
|
1874
|
+
},
|
|
1875
|
+
"disabled": {
|
|
1876
|
+
"type": "boolean",
|
|
1877
|
+
"description": "The disabled attribute on the input"
|
|
1878
|
+
},
|
|
1879
|
+
"required": {
|
|
1880
|
+
"type": "boolean",
|
|
1881
|
+
"description": "The required attribute on the input"
|
|
1882
|
+
},
|
|
1883
|
+
"value": {
|
|
1884
|
+
"type": "string",
|
|
1885
|
+
"description": "The value of the form field."
|
|
1886
|
+
}
|
|
1887
|
+
},
|
|
1888
|
+
"properties": {
|
|
1889
|
+
"fieldId": {
|
|
1890
|
+
"type": "string",
|
|
1891
|
+
"description": "The unique id of the field\n<br/><br/> _*This property is dynamically set_"
|
|
1892
|
+
},
|
|
1893
|
+
"fieldNote": {
|
|
1894
|
+
"type": "string",
|
|
1895
|
+
"description": "The text that displays below in text field input"
|
|
1896
|
+
},
|
|
1897
|
+
"ariaLive": {
|
|
1898
|
+
"type": "string",
|
|
1899
|
+
"values": [
|
|
1900
|
+
"polite",
|
|
1901
|
+
"assertive"
|
|
1902
|
+
],
|
|
1903
|
+
"default": "polite",
|
|
1904
|
+
"description": "Controls how the voiceover will experience the new information when field note changes,\nimmediately (used for more urgently needed updates) using `assertive` or at the next convenient\npause in their navigation using `polite`."
|
|
1905
|
+
},
|
|
1906
|
+
"ariaDescribedBy": {
|
|
1907
|
+
"type": "string",
|
|
1908
|
+
"description": "Used to connect the field note in text field to the text menu for accessibility"
|
|
1909
|
+
},
|
|
1910
|
+
"errorText": {
|
|
1911
|
+
"type": "string",
|
|
1912
|
+
"default": "Error",
|
|
1913
|
+
"description": "Visually hidden text that always signifies that this is an error for screen reader usage"
|
|
1914
|
+
},
|
|
1915
|
+
"errorNote": {
|
|
1916
|
+
"type": "string",
|
|
1917
|
+
"description": "The error field note that appears below the default field note"
|
|
1918
|
+
},
|
|
1919
|
+
"validationAriaDescribedBy": {
|
|
1920
|
+
"type": "string",
|
|
1921
|
+
"description": "Additional aria-describedby connection to id for additional success and error notes to be accessible"
|
|
1922
|
+
},
|
|
1923
|
+
"successText": {
|
|
1924
|
+
"type": "string",
|
|
1925
|
+
"default": "Success",
|
|
1926
|
+
"description": "Visually hidden text that always signifies that this is successful for screen reader usage"
|
|
1927
|
+
},
|
|
1928
|
+
"successNote": {
|
|
1929
|
+
"type": "string",
|
|
1930
|
+
"description": "The success field note that appears below the default field note"
|
|
1931
|
+
},
|
|
1932
|
+
"isError": {
|
|
1933
|
+
"type": "boolean",
|
|
1934
|
+
"description": "Changes the component's treatment to represent an error state"
|
|
1935
|
+
},
|
|
1936
|
+
"isSuccess": {
|
|
1937
|
+
"type": "boolean",
|
|
1938
|
+
"description": "Changes the component's treatment to represent a success state"
|
|
1939
|
+
}
|
|
1940
|
+
},
|
|
1941
|
+
"slots": {},
|
|
1942
|
+
"events": {},
|
|
1943
|
+
"cssProperties": {},
|
|
1944
|
+
"examples": []
|
|
1945
|
+
},
|
|
1946
|
+
{
|
|
1947
|
+
"name": "cre8-field-note",
|
|
1948
|
+
"category": "Forms",
|
|
1949
|
+
"description": "Field Note gives direction on how to fill out a form field and to alert users of form errors and successes.\nIt’s used below an input field and never on its own.",
|
|
1950
|
+
"attributes": {},
|
|
1951
|
+
"properties": {
|
|
1952
|
+
"isError": {
|
|
1953
|
+
"type": "boolean",
|
|
1954
|
+
"description": "Changes the component's treatment to represent an error"
|
|
1955
|
+
},
|
|
1956
|
+
"isSuccess": {
|
|
1957
|
+
"type": "boolean",
|
|
1958
|
+
"description": "Changes the component's treatment to represent a success"
|
|
1959
|
+
},
|
|
1960
|
+
"iconName": {
|
|
1961
|
+
"type": "string",
|
|
1962
|
+
"description": "DEPRECATED: Icon name used for the icon before to the field note"
|
|
1963
|
+
}
|
|
1964
|
+
},
|
|
1965
|
+
"slots": {
|
|
1966
|
+
"default": {
|
|
1967
|
+
"description": "The note content"
|
|
1968
|
+
}
|
|
1969
|
+
},
|
|
1970
|
+
"events": {},
|
|
1971
|
+
"cssProperties": {},
|
|
1972
|
+
"examples": []
|
|
1973
|
+
},
|
|
1974
|
+
{
|
|
1975
|
+
"name": "cre8-multi-select",
|
|
1976
|
+
"category": "Forms",
|
|
1977
|
+
"description": "Multiselect is used when multiple options can be chosen from a static dropdown\nThis component has a list of items in the dropdown that can be added as \"selected tags\"\nThe checkbox will always reflect the selected nature of the item and is not removed\nfrom the dropdown when clicked, the tags will be added and removed based on their state.\n\nEvent `selectedItemsChange` emits whenever a tag is added or remove from the list and the\ncurrent list after the change is given in the detail.",
|
|
1978
|
+
"attributes": {
|
|
1979
|
+
"items": {
|
|
1980
|
+
"type": "string[]",
|
|
1981
|
+
"default": "[]",
|
|
1982
|
+
"description": "The list of string items the user can choose in the dropdown\n\nNote: For passing props containing arrays and complex types, you should pass the props using a\nperiod in from of the prop like so: `.items=\"[]\"`\n(this is only needed for Web Components and not the React version)"
|
|
1983
|
+
},
|
|
1984
|
+
"label": {
|
|
1985
|
+
"type": "string",
|
|
1986
|
+
"description": "The required label that appears above the multiselect"
|
|
1987
|
+
},
|
|
1988
|
+
"disabled": {
|
|
1989
|
+
"type": "boolean",
|
|
1990
|
+
"description": "The disabled attribute on the select"
|
|
1991
|
+
}
|
|
1992
|
+
},
|
|
1993
|
+
"properties": {
|
|
1994
|
+
"preselectedItems": {
|
|
1995
|
+
"type": "string[]",
|
|
1996
|
+
"description": "The list of string items that are initially in the selected list of tags\nNote: This list MUST be a subset of the array of items to function.\ni.e. if items=['cat', 'dog', 'bird'], preselectedItems=['cat'] is valid\nwhile preselectedItems=['cat', 'goat'] is not and will break the component.\n\nNote: For passing props containing arrays and complex types, you should pass the props using a\nperiod in from of the prop like so: `.items=\"[]\"`\n(this is only needed for Web Components and not the React version)"
|
|
1997
|
+
},
|
|
1998
|
+
"fieldId": {
|
|
1999
|
+
"type": "string",
|
|
2000
|
+
"description": "The unique id of the select"
|
|
2001
|
+
},
|
|
2002
|
+
"fieldNote": {
|
|
2003
|
+
"type": "string",
|
|
2004
|
+
"description": "Optional field note text can be added to provide additional field guidance."
|
|
2005
|
+
},
|
|
2006
|
+
"ariaDescribedBy": {
|
|
2007
|
+
"type": "string",
|
|
2008
|
+
"description": "Used to connect the field note in text field to the text menu for accessibility"
|
|
2009
|
+
},
|
|
2010
|
+
"validationAriaDescribedBy": {
|
|
2011
|
+
"type": "string",
|
|
2012
|
+
"description": "Additional aria-describedby connection to id for additional success and error notes to be accessible"
|
|
2013
|
+
},
|
|
2014
|
+
"isError": {
|
|
2015
|
+
"type": "boolean",
|
|
2016
|
+
"description": "Changes the component's treatment to represent an error state"
|
|
2017
|
+
},
|
|
2018
|
+
"errorNote": {
|
|
2019
|
+
"type": "string",
|
|
2020
|
+
"description": "The error field note that appears below the default field note"
|
|
2021
|
+
},
|
|
2022
|
+
"isSuccess": {
|
|
2023
|
+
"type": "boolean",
|
|
2024
|
+
"description": "Changes the component's treatment to represent a success state"
|
|
2025
|
+
},
|
|
2026
|
+
"successNote": {
|
|
2027
|
+
"type": "string",
|
|
2028
|
+
"description": "The success field note that appears below the default field note"
|
|
2029
|
+
},
|
|
2030
|
+
"selectedTagItems": {
|
|
2031
|
+
"type": "string[]"
|
|
2032
|
+
},
|
|
2033
|
+
"dropdownOpen": {
|
|
2034
|
+
"type": "boolean"
|
|
2035
|
+
}
|
|
2036
|
+
},
|
|
2037
|
+
"slots": {},
|
|
2038
|
+
"events": {
|
|
2039
|
+
"selectedItemsChange": {
|
|
2040
|
+
"detail": {}
|
|
2041
|
+
}
|
|
2042
|
+
},
|
|
2043
|
+
"cssProperties": {},
|
|
2044
|
+
"examples": []
|
|
2045
|
+
},
|
|
2046
|
+
{
|
|
2047
|
+
"name": "cre8-radio-field",
|
|
2048
|
+
"category": "Forms",
|
|
2049
|
+
"description": "Radio Field is the parent container for `radio-field-item`.\nIt is required to allow for grouping numerous radio fields that need additional context (in the form of `<legend>`).\nIt also provides accessibility roles, aria attributes and field note messaging on the group.\n\nSee [radio-field-item](?path=/story/cre8-components-radio-field-item--default) for more guidance on its usage.",
|
|
2050
|
+
"attributes": {
|
|
2051
|
+
"label": {
|
|
2052
|
+
"type": "string",
|
|
2053
|
+
"description": "Radio field legend label"
|
|
2054
|
+
}
|
|
2055
|
+
},
|
|
2056
|
+
"properties": {
|
|
2057
|
+
"fieldNote": {
|
|
2058
|
+
"type": "string",
|
|
2059
|
+
"description": "Radio Field Note"
|
|
2060
|
+
},
|
|
2061
|
+
"ariaDescribedBy": {
|
|
2062
|
+
"type": "string",
|
|
2063
|
+
"description": "Radio container fieldnote aria describe by"
|
|
2064
|
+
},
|
|
2065
|
+
"fieldNoteIconName": {
|
|
2066
|
+
"type": "string",
|
|
2067
|
+
"description": "Radio container fieldnote icon name"
|
|
2068
|
+
},
|
|
2069
|
+
"fieldNoteKnockout": {
|
|
2070
|
+
"type": "boolean",
|
|
2071
|
+
"description": "Radio container fieldnote knockout"
|
|
2072
|
+
},
|
|
2073
|
+
"isSuccess": {
|
|
2074
|
+
"type": "boolean",
|
|
2075
|
+
"description": "Radio container fieldnote isSuccess"
|
|
2076
|
+
},
|
|
2077
|
+
"isError": {
|
|
2078
|
+
"type": "boolean",
|
|
2079
|
+
"description": "Radio container fieldnote isError"
|
|
2080
|
+
}
|
|
2081
|
+
},
|
|
2082
|
+
"slots": {
|
|
2083
|
+
"default": {
|
|
2084
|
+
"description": "The component content, which should be a set of `radio-field-item`s"
|
|
2085
|
+
}
|
|
2086
|
+
},
|
|
2087
|
+
"events": {},
|
|
2088
|
+
"cssProperties": {},
|
|
2089
|
+
"examples": []
|
|
2090
|
+
},
|
|
2091
|
+
{
|
|
2092
|
+
"name": "cre8-radio-field-item",
|
|
2093
|
+
"category": "Forms",
|
|
2094
|
+
"description": "A Radio Field Item adds a radio button to a Radio Field. Radio buttons let a user choose only one of several\noptions. Do not use a single radio button, because once selected, it cannot be de-selected. If the user can only\nchoose one, none or many options, use Checkbox instead.",
|
|
2095
|
+
"attributes": {
|
|
2096
|
+
"checked": {
|
|
2097
|
+
"type": "boolean",
|
|
2098
|
+
"description": "A Boolean attribute which, if present, sets the radio button as selected."
|
|
2099
|
+
},
|
|
2100
|
+
"label": {
|
|
2101
|
+
"type": "string",
|
|
2102
|
+
"description": "The label attribute is used to assign a value to the label element corresponding to this radio button."
|
|
2103
|
+
},
|
|
2104
|
+
"name": {
|
|
2105
|
+
"type": "string",
|
|
2106
|
+
"description": "The name of the form field"
|
|
2107
|
+
},
|
|
2108
|
+
"disabled": {
|
|
2109
|
+
"type": "boolean",
|
|
2110
|
+
"description": "The Boolean disabled attribute, when present, makes the element not mutable, focusable, or even submitted with\nthe form. The user can neither edit nor focus on the control, nor its form control descendants."
|
|
2111
|
+
},
|
|
2112
|
+
"required": {
|
|
2113
|
+
"type": "boolean",
|
|
2114
|
+
"description": "Required attribute"
|
|
2115
|
+
},
|
|
2116
|
+
"value": {
|
|
2117
|
+
"type": "string",
|
|
2118
|
+
"description": "The value of the form field."
|
|
2119
|
+
}
|
|
2120
|
+
},
|
|
2121
|
+
"properties": {
|
|
2122
|
+
"ariaDescribedBy": {
|
|
2123
|
+
"type": "string",
|
|
2124
|
+
"description": "Identifies the element that provides a detailed, extended description for the object."
|
|
2125
|
+
},
|
|
2126
|
+
"fieldId": {
|
|
2127
|
+
"type": "string",
|
|
2128
|
+
"description": "The fieldId attribute is assigned to the HTML input element of the radio button and the for attribute of the\ncorresponding label."
|
|
2129
|
+
},
|
|
2130
|
+
"fieldNote": {
|
|
2131
|
+
"type": "string",
|
|
2132
|
+
"description": "A FieldNote can be placed to provide guidance. It's frequently used to in the context of form fields for extra\ninformation or validation messages."
|
|
2133
|
+
},
|
|
2134
|
+
"fieldNoteIconName": {
|
|
2135
|
+
"type": "string",
|
|
2136
|
+
"description": "Sets the item fieldnote icon.\n\n- **check** renders a badge with success state treatment\n- **error** renders a badge with error state treatment"
|
|
2137
|
+
},
|
|
2138
|
+
"fieldNoteKnockout": {
|
|
2139
|
+
"type": "boolean",
|
|
2140
|
+
"description": "Radio item fieldnote knockout"
|
|
2141
|
+
},
|
|
2142
|
+
"fieldNoteIsError": {
|
|
2143
|
+
"type": "boolean",
|
|
2144
|
+
"description": "Sets the error state of the fieldnote."
|
|
2145
|
+
},
|
|
2146
|
+
"isError": {
|
|
2147
|
+
"type": "boolean",
|
|
2148
|
+
"description": "The isError attribute is used to indicate an error state related to the radio button."
|
|
2149
|
+
},
|
|
2150
|
+
"isSuccess": {
|
|
2151
|
+
"type": "boolean",
|
|
2152
|
+
"description": "The isSuccess attribute is used to indicate a success state related to the radio button."
|
|
2153
|
+
},
|
|
2154
|
+
"type": {
|
|
2155
|
+
"type": "string",
|
|
2156
|
+
"description": "The type of form control (text, checkbox, radio, etc.)"
|
|
2157
|
+
}
|
|
2158
|
+
},
|
|
2159
|
+
"slots": {},
|
|
2160
|
+
"events": {},
|
|
2161
|
+
"cssProperties": {},
|
|
2162
|
+
"examples": []
|
|
2163
|
+
},
|
|
2164
|
+
{
|
|
2165
|
+
"name": "cre8-select",
|
|
2166
|
+
"category": "Forms",
|
|
2167
|
+
"description": "The Select control is designed and built to be used for selecting between choices in a form.\nIt is not a Dropdown control which is generally used for displaying lists of choices\nthat act as links or actions, like filter options.\n\nConsider the use of a Select control carefully.\nWhen you have less than 5 options for the user to choose from,\nRadio or Checkbox inputs may be a better choice to display all of the options at once.\nUsers have to slow down to scan a list with more than 15 options,\nso using an option group to give the options hierarchy may help users find their choice faster.\nAlternately, a text input field might be a more appropriate control to use when there are too many options,\nespecially when used with typeahead/auto-complete.\n\n## How to use\n1. The collapsed default state always shows a default placeholder value or a selected value.\n2. Sort list items in a logical order, such as grouping highly related options together,\n placing most common options first, using alphabetical or numeric orders or dates in chronological order.\n3. A list that includes 6+ items should show a scrollbar.\n4. Users should be able to use a keystroke to quickly jump\n to selecting an option that begins with the entered letter.\n5. Utilize appropriate native controls for when a user is on a mobile device rather than our custom Select.\n6. Adhere to our common form field conventions and always include a Label,\n provide short and clear error messages in context, avoid using the Read-only\n and Disabled states as much as possible, and utilize the info/formatting tip\n or helpful link rather than placeholder text.",
|
|
2168
|
+
"attributes": {
|
|
2169
|
+
"items": {
|
|
2170
|
+
"type": "(Cre8SelectOption | Cre8SelectOptionGroup)[]",
|
|
2171
|
+
"default": "[]",
|
|
2172
|
+
"description": "A mix of Cre8SelectOption and Cre8SelectOptionGroup definitions:\n- Cre8SelectOption\n - label: option label text - `string`\n - value: option value - `number | string`\n- Cre8SelectOptionGroup\n - optGroupLabel: optgroup label text - `string`\n - options: Array of multiple Cre8SelectOption items - `Cre8SelectOption[]`"
|
|
2173
|
+
},
|
|
2174
|
+
"label": {
|
|
2175
|
+
"type": "string",
|
|
2176
|
+
"default": "Label",
|
|
2177
|
+
"description": "The required label that appears above the select"
|
|
2178
|
+
},
|
|
2179
|
+
"name": {
|
|
2180
|
+
"type": "string",
|
|
2181
|
+
"description": "The name of the form field"
|
|
2182
|
+
},
|
|
2183
|
+
"disabled": {
|
|
2184
|
+
"type": "boolean",
|
|
2185
|
+
"description": "The disabled attribute on the select"
|
|
2186
|
+
},
|
|
2187
|
+
"required": {
|
|
2188
|
+
"type": "boolean",
|
|
2189
|
+
"default": false,
|
|
2190
|
+
"description": "The required attribute on the select"
|
|
2191
|
+
},
|
|
2192
|
+
"value": {
|
|
2193
|
+
"type": "string",
|
|
2194
|
+
"description": "The value of the form field."
|
|
2195
|
+
}
|
|
2196
|
+
},
|
|
2197
|
+
"properties": {
|
|
2198
|
+
"fieldId": {
|
|
2199
|
+
"type": "string",
|
|
2200
|
+
"description": "The unique id of the select"
|
|
2201
|
+
},
|
|
2202
|
+
"fieldNote": {
|
|
2203
|
+
"type": "string",
|
|
2204
|
+
"description": "Optional field note text can be added to provide additional field guidance."
|
|
2205
|
+
},
|
|
2206
|
+
"ariaDescribedBy": {
|
|
2207
|
+
"type": "string",
|
|
2208
|
+
"description": "Used to connect the field note in text field to the text menu for accessibility"
|
|
2209
|
+
},
|
|
2210
|
+
"validationAriaDescribedBy": {
|
|
2211
|
+
"type": "string",
|
|
2212
|
+
"description": "Additional aria-describedby connection to id for additional success and error notes to be accessible"
|
|
2213
|
+
},
|
|
2214
|
+
"errorNote": {
|
|
2215
|
+
"type": "string",
|
|
2216
|
+
"description": "The error field note that appears below the default field note"
|
|
2217
|
+
},
|
|
2218
|
+
"successNote": {
|
|
2219
|
+
"type": "string",
|
|
2220
|
+
"description": "The success field note that appears below the default field note"
|
|
2221
|
+
},
|
|
2222
|
+
"isError": {
|
|
2223
|
+
"type": "boolean",
|
|
2224
|
+
"description": "Changes the component's treatment to represent an error state"
|
|
2225
|
+
},
|
|
2226
|
+
"isSuccess": {
|
|
2227
|
+
"type": "boolean",
|
|
2228
|
+
"description": "Changes the component's treatment to represent a success state"
|
|
2229
|
+
},
|
|
2230
|
+
"type": {
|
|
2231
|
+
"type": "\"select\"",
|
|
2232
|
+
"description": "The type of form control (text, checkbox, radio, etc.)"
|
|
2233
|
+
}
|
|
2234
|
+
},
|
|
2235
|
+
"slots": {
|
|
2236
|
+
"fieldNote": {
|
|
2237
|
+
"description": "Container for optional field note content"
|
|
2238
|
+
}
|
|
2239
|
+
},
|
|
2240
|
+
"events": {
|
|
2241
|
+
"change": {
|
|
2242
|
+
"detail": {}
|
|
2243
|
+
}
|
|
2244
|
+
},
|
|
2245
|
+
"cssProperties": {},
|
|
2246
|
+
"examples": []
|
|
2247
|
+
},
|
|
2248
|
+
{
|
|
2249
|
+
"name": "cre8-select-tile",
|
|
2250
|
+
"category": "Forms",
|
|
2251
|
+
"description": "The Select Tile component is a short block of content inside a visual\ncontainer that can be used in place of checkboxes, radio buttons, and\nlinks. It allows you to add more descriptive and visually appealing\ncontent for these actions while letting you compare different choices\neither side-by-side or on top of each other.\n\nTypically you could use the \"header\" slot for an icon, and the \"title\"\nand \"body\" slots for a content title and body text below it.\n\nThe css parts are shown here wrapped in ::part() because otherwise Storybook\nwon't render them and the slots if they have the same name.\nSee https://developer.mozilla.org/en-US/docs/Web/CSS/::part",
|
|
2252
|
+
"attributes": {
|
|
2253
|
+
"variant": {
|
|
2254
|
+
"type": "string",
|
|
2255
|
+
"values": [
|
|
2256
|
+
"bare",
|
|
2257
|
+
"horizontal",
|
|
2258
|
+
"horizontal-bare"
|
|
2259
|
+
],
|
|
2260
|
+
"description": "Style variants\n- **bare** renders a select-tile without a border and without padding around the content\n- **horizontal** renders a select-tile with header, body, footer oriented in a row rather than a column\n- **horizontal-bare** renders a select-tile with header, body, footer\n oriented in a row rather than a column without a border and without padding around the content"
|
|
2261
|
+
},
|
|
2262
|
+
"align": {
|
|
2263
|
+
"type": "\"center\"",
|
|
2264
|
+
"description": "Align variants\n<cre8-text-passage size=\"sm\">\n<ul>\n<li>**center** renders a select-tile that has center aligned content/text</li>\n</ul>\n</cre8-text-passage>"
|
|
2265
|
+
},
|
|
2266
|
+
"checked": {
|
|
2267
|
+
"type": "boolean",
|
|
2268
|
+
"description": "Checked State.\nNote: the `checked` attribute sets the `defaultChecked` property, as well\nas sets the initial value for the `checked` property."
|
|
2269
|
+
},
|
|
2270
|
+
"type": {
|
|
2271
|
+
"type": "string",
|
|
2272
|
+
"values": [
|
|
2273
|
+
"checkbox",
|
|
2274
|
+
"radio"
|
|
2275
|
+
],
|
|
2276
|
+
"default": "radio",
|
|
2277
|
+
"description": "Should this Select Tile behave as a radio button or a checkbox?"
|
|
2278
|
+
},
|
|
2279
|
+
"name": {
|
|
2280
|
+
"type": "string",
|
|
2281
|
+
"description": "The name of the form field"
|
|
2282
|
+
},
|
|
2283
|
+
"disabled": {
|
|
2284
|
+
"type": "boolean",
|
|
2285
|
+
"description": "Disabled State"
|
|
2286
|
+
},
|
|
2287
|
+
"required": {
|
|
2288
|
+
"type": "boolean",
|
|
2289
|
+
"description": "Required attribute"
|
|
2290
|
+
},
|
|
2291
|
+
"value": {
|
|
2292
|
+
"type": "string",
|
|
2293
|
+
"description": "The value of the form field."
|
|
2294
|
+
}
|
|
2295
|
+
},
|
|
2296
|
+
"properties": {
|
|
2297
|
+
"variantBreakToVertical": {
|
|
2298
|
+
"type": "string",
|
|
2299
|
+
"values": [
|
|
2300
|
+
"sm",
|
|
2301
|
+
"lg",
|
|
2302
|
+
"none",
|
|
2303
|
+
"md",
|
|
2304
|
+
"sm-2",
|
|
2305
|
+
"xl",
|
|
2306
|
+
"xxl"
|
|
2307
|
+
],
|
|
2308
|
+
"default": "sm",
|
|
2309
|
+
"description": "Which breakpoint, if any, to switch to verticial.\nOnly useful for horizontal variants. Defaults to 'sm'."
|
|
2310
|
+
},
|
|
2311
|
+
"checkPosition": {
|
|
2312
|
+
"type": "string",
|
|
2313
|
+
"values": [
|
|
2314
|
+
"none",
|
|
2315
|
+
"left",
|
|
2316
|
+
"right",
|
|
2317
|
+
"top-right"
|
|
2318
|
+
],
|
|
2319
|
+
"default": "right",
|
|
2320
|
+
"description": "Where does the checkmark or radio button go?\nIt disappears on 'none'. Only top-right is supported for vertical variants."
|
|
2321
|
+
},
|
|
2322
|
+
"radioVariant": {
|
|
2323
|
+
"type": "string",
|
|
2324
|
+
"values": [
|
|
2325
|
+
"dot",
|
|
2326
|
+
"check"
|
|
2327
|
+
],
|
|
2328
|
+
"default": "dot",
|
|
2329
|
+
"description": "In radio mode, whether to use the circle with the dot, or the rounded check."
|
|
2330
|
+
},
|
|
2331
|
+
"fieldId": {
|
|
2332
|
+
"type": "string",
|
|
2333
|
+
"description": "Select Tile FieldId"
|
|
2334
|
+
},
|
|
2335
|
+
"isError": {
|
|
2336
|
+
"type": "boolean",
|
|
2337
|
+
"description": "Error State"
|
|
2338
|
+
},
|
|
2339
|
+
"isSuccess": {
|
|
2340
|
+
"type": "boolean",
|
|
2341
|
+
"description": "Radio item fieldnote isSuccess"
|
|
2342
|
+
},
|
|
2343
|
+
"shadowRootOptions": {
|
|
2344
|
+
"type": "{ delegatesFocus: boolean; mode: ShadowRootMode; slotAssignment?: SlotAssignmentMode; }"
|
|
2345
|
+
},
|
|
2346
|
+
"defaultChecked": {
|
|
2347
|
+
"type": "boolean",
|
|
2348
|
+
"description": "The default checked state when the element first renders or is reset.\n\nNote: the attribute is named `checked` and the property is\nnamed `defaultChecked`. This is the same as a regular radio button."
|
|
2349
|
+
}
|
|
2350
|
+
},
|
|
2351
|
+
"slots": {
|
|
2352
|
+
"\"\"": {
|
|
2353
|
+
"description": "The default slot goes into the center, main part of the Select Tile.\n Consider using title and body instead."
|
|
2354
|
+
},
|
|
2355
|
+
"header": {
|
|
2356
|
+
"description": "The top or left part of the Select Tile"
|
|
2357
|
+
},
|
|
2358
|
+
"footer": {
|
|
2359
|
+
"description": "The bottom or right part of the Select Tile"
|
|
2360
|
+
},
|
|
2361
|
+
"title": {
|
|
2362
|
+
"description": "The title part of the Select Tile, use with body slot and\n instead of the default slot for appropriate typography."
|
|
2363
|
+
},
|
|
2364
|
+
"body": {
|
|
2365
|
+
"description": "The \"body\" part of the Select Tile, which appears under\n the title slot and receives apporpriate typography."
|
|
2366
|
+
}
|
|
2367
|
+
},
|
|
2368
|
+
"events": {
|
|
2369
|
+
"change": {
|
|
2370
|
+
"detail": {}
|
|
2371
|
+
},
|
|
2372
|
+
"input": {
|
|
2373
|
+
"detail": {}
|
|
2374
|
+
}
|
|
2375
|
+
},
|
|
2376
|
+
"cssProperties": {},
|
|
2377
|
+
"examples": [
|
|
2378
|
+
{
|
|
2379
|
+
"description": "Bare select-tile",
|
|
2380
|
+
"html": "<cre8-select-tile variant=\"bare\"></cre8-select-tile>"
|
|
2381
|
+
}
|
|
2382
|
+
]
|
|
2383
|
+
},
|
|
2384
|
+
{
|
|
2385
|
+
"name": "cre8-select-tile-list",
|
|
2386
|
+
"category": "Forms",
|
|
2387
|
+
"description": "Select Tile List is a container design to hold multiple Select Tile Components.",
|
|
2388
|
+
"attributes": {
|
|
2389
|
+
"variant": {
|
|
2390
|
+
"type": "string",
|
|
2391
|
+
"values": [
|
|
2392
|
+
"columns",
|
|
2393
|
+
"rows"
|
|
2394
|
+
],
|
|
2395
|
+
"default": "columns",
|
|
2396
|
+
"description": "Whether to show the tiles side by side (columns) or stacked vertically (rows)."
|
|
2397
|
+
},
|
|
2398
|
+
"label": {
|
|
2399
|
+
"type": "string",
|
|
2400
|
+
"description": "Select Tile container label"
|
|
2401
|
+
}
|
|
2402
|
+
},
|
|
2403
|
+
"properties": {
|
|
2404
|
+
"fieldNote": {
|
|
2405
|
+
"type": "string",
|
|
2406
|
+
"description": "Select Tile container fieldnote"
|
|
2407
|
+
},
|
|
2408
|
+
"ariaDescribedBy": {
|
|
2409
|
+
"type": "string",
|
|
2410
|
+
"description": "Select Tile container fieldnote aria describe by"
|
|
2411
|
+
},
|
|
2412
|
+
"fieldNoteIconName": {
|
|
2413
|
+
"type": "string",
|
|
2414
|
+
"description": "Select Tile container fieldnote icon name"
|
|
2415
|
+
},
|
|
2416
|
+
"fieldNoteKnockout": {
|
|
2417
|
+
"type": "boolean",
|
|
2418
|
+
"description": "Select Tile container fieldnote knockout"
|
|
2419
|
+
},
|
|
2420
|
+
"fieldNoteIsSuccess": {
|
|
2421
|
+
"type": "boolean",
|
|
2422
|
+
"description": "Select Tile container fieldnote isSuccess"
|
|
2423
|
+
},
|
|
2424
|
+
"fieldNoteIsError": {
|
|
2425
|
+
"type": "boolean",
|
|
2426
|
+
"description": "Select Tile container fieldnote isError"
|
|
2427
|
+
}
|
|
2428
|
+
},
|
|
2429
|
+
"slots": {
|
|
2430
|
+
"\"\"": {
|
|
2431
|
+
"description": "The default slot norminally contains multiple `<select-tile />` Components."
|
|
2432
|
+
}
|
|
2433
|
+
},
|
|
2434
|
+
"events": {},
|
|
2435
|
+
"cssProperties": {
|
|
2436
|
+
"--cre8-select-tile-list-item-width": {
|
|
2437
|
+
"description": "Width of each child. Not used for horizontal."
|
|
2438
|
+
}
|
|
2439
|
+
},
|
|
2440
|
+
"examples": [
|
|
2441
|
+
{
|
|
2442
|
+
"description": "Columns select-tile-list",
|
|
2443
|
+
"html": "<cre8-select-tile-list variant=\"columns\"></cre8-select-tile-list>"
|
|
2444
|
+
}
|
|
2445
|
+
]
|
|
2446
|
+
},
|
|
2447
|
+
{
|
|
2448
|
+
"name": "cre8-band",
|
|
2449
|
+
"category": "Layout",
|
|
2450
|
+
"description": "Band component.",
|
|
2451
|
+
"attributes": {
|
|
2452
|
+
"variant": {
|
|
2453
|
+
"type": "\"branded\"",
|
|
2454
|
+
"description": "Gradient variant\n<cre8-text-passage size=\"sm\">\n<ul>\n<li>**1** renders the band with the set gradient background</li>\n</ul>\n</cre8-text-passage>"
|
|
2455
|
+
}
|
|
2456
|
+
},
|
|
2457
|
+
"properties": {
|
|
2458
|
+
"fullHeight": {
|
|
2459
|
+
"type": "boolean",
|
|
2460
|
+
"description": "Full height variant\n1) Sets the height to 100%"
|
|
2461
|
+
}
|
|
2462
|
+
},
|
|
2463
|
+
"slots": {
|
|
2464
|
+
"default": {
|
|
2465
|
+
"description": "The band content"
|
|
2466
|
+
}
|
|
2467
|
+
},
|
|
2468
|
+
"events": {},
|
|
2469
|
+
"cssProperties": {},
|
|
2470
|
+
"examples": []
|
|
2471
|
+
},
|
|
2472
|
+
{
|
|
2473
|
+
"name": "cre8-card",
|
|
2474
|
+
"category": "Layout",
|
|
2475
|
+
"description": "The card component acts a general container element sectioned off by slots: `header`, `body`, `footer`.\n\n# How to Use\n1. Wrap the card component tags around any html template code which has been properly imported into the file.\n2. Decide the layout that best fits the designs assigned to your work.\nGenerally, we recommend visual elements appear in the `header` (optional slot),\nwhile `body` remains reserved for custom html content that gives further context and meaning to the `header`.\n3. The card defaults to a column and includes a `horizontal` directional variant.\nIf you have a card where the layout of the content is more aligned horizontally,\nusing the `horizontal` variant will ease the construction of your component\n4. Finally, we typically recommend reserving the footer for any interactive elements\nsuch as buttons for navigating to further information.\n\n\nNOTE: Adjusting props not mentioned above may result in unpredictable states",
|
|
2476
|
+
"attributes": {
|
|
2477
|
+
"variant": {
|
|
2478
|
+
"type": "string",
|
|
2479
|
+
"values": [
|
|
2480
|
+
"bare",
|
|
2481
|
+
"horizontal",
|
|
2482
|
+
"horizontal-bare"
|
|
2483
|
+
],
|
|
2484
|
+
"description": "Style variants\n- **bare** renders a card without a border and without padding around the content\n- **horizontal** renders a card with header, body, footer oriented in a row rather than a column\n- **horizontal-bare** renders a card with header, body, footer oriented in a row rather than a column\n without a border and without padding around the content"
|
|
2485
|
+
},
|
|
2486
|
+
"align": {
|
|
2487
|
+
"type": "\"center\"",
|
|
2488
|
+
"description": "Alignment variant\n- **center** renders a card that has center aligned content/text"
|
|
2489
|
+
}
|
|
2490
|
+
},
|
|
2491
|
+
"properties": {},
|
|
2492
|
+
"slots": {
|
|
2493
|
+
"body": {
|
|
2494
|
+
"description": "The card's body content"
|
|
2495
|
+
},
|
|
2496
|
+
"header": {
|
|
2497
|
+
"description": "(Optional) Content in the card's header"
|
|
2498
|
+
},
|
|
2499
|
+
"footer": {
|
|
2500
|
+
"description": "(Optional) Content in the card's footer"
|
|
2501
|
+
}
|
|
2502
|
+
},
|
|
2503
|
+
"events": {},
|
|
2504
|
+
"cssProperties": {},
|
|
2505
|
+
"examples": [
|
|
2506
|
+
{
|
|
2507
|
+
"description": "Bare card",
|
|
2508
|
+
"html": "<cre8-card variant=\"bare\"></cre8-card>"
|
|
2509
|
+
}
|
|
2510
|
+
]
|
|
2511
|
+
},
|
|
2512
|
+
{
|
|
2513
|
+
"name": "cre8-divider",
|
|
2514
|
+
"category": "Layout",
|
|
2515
|
+
"description": "The divider component is a separator between sections of content or groups of items.\nIt often contains a horizontal or vertical line.",
|
|
2516
|
+
"attributes": {
|
|
2517
|
+
"variant": {
|
|
2518
|
+
"type": "string",
|
|
2519
|
+
"values": [
|
|
2520
|
+
"horizontal",
|
|
2521
|
+
"vertical"
|
|
2522
|
+
],
|
|
2523
|
+
"default": "horizontal",
|
|
2524
|
+
"description": "Divider variants\n- By default, the component renders the horizontal divider\n- **vertical** renders the vertical divider"
|
|
2525
|
+
},
|
|
2526
|
+
"status": {
|
|
2527
|
+
"type": "string",
|
|
2528
|
+
"description": "Status (a color variant prop)\n- By default, the divider has gray color.\n- **brand**, the divider has blue color.\n- **knockout**, the divider has white color."
|
|
2529
|
+
}
|
|
2530
|
+
},
|
|
2531
|
+
"properties": {},
|
|
2532
|
+
"slots": {},
|
|
2533
|
+
"events": {},
|
|
2534
|
+
"cssProperties": {},
|
|
2535
|
+
"examples": [
|
|
2536
|
+
{
|
|
2537
|
+
"description": "Horizontal divider",
|
|
2538
|
+
"html": "<cre8-divider variant=\"horizontal\"></cre8-divider>"
|
|
2539
|
+
}
|
|
2540
|
+
]
|
|
2541
|
+
},
|
|
2542
|
+
{
|
|
2543
|
+
"name": "cre8-grid",
|
|
2544
|
+
"category": "Layout",
|
|
2545
|
+
"description": "Grid component.",
|
|
2546
|
+
"attributes": {
|
|
2547
|
+
"variant": {
|
|
2548
|
+
"type": "string",
|
|
2549
|
+
"values": [
|
|
2550
|
+
"side-by-side",
|
|
2551
|
+
"2up",
|
|
2552
|
+
"3up",
|
|
2553
|
+
"1-3up",
|
|
2554
|
+
"4up",
|
|
2555
|
+
"1-4up",
|
|
2556
|
+
"1-2-4up",
|
|
2557
|
+
"2-4-6up"
|
|
2558
|
+
],
|
|
2559
|
+
"description": "Style variant\n- **side-by-side** yields a grid whose grid items display side-by-side (2 per row) on all screen sizes\n- **2up** yields a grid whose grid items are stacked on small screens\n but display side-by-side when enough screen real estate is available to do so\n- **3up** yields a grid whose grid items are stacked on small screens,\n transforms to a 2-across pattern and then transforms again to a 3-across pattern\n- **1-3up** yields a grid whose grid items are stacked on small screens\n and transforms to a 3-across pattern on larger screens\n- **4up** yields a grid whose grid items are stacked on small screens,\n transforms to a 2-across pattern, transforms again to a 3-across pattern,\n and ultimately transforms to a 4-across pattern\n- **1-2-4up** yields a grid whose grid items are stacked on small screens,\n transforms to a 2-across pattern, and ultimately transforms to a 4-across pattern\n- **1-4up** yields a grid whose grid items are stacked on small screens,\n transforms to a 4-across pattern on medium/large screens"
|
|
2560
|
+
},
|
|
2561
|
+
"gap": {
|
|
2562
|
+
"type": "string",
|
|
2563
|
+
"values": [
|
|
2564
|
+
"sm",
|
|
2565
|
+
"lg",
|
|
2566
|
+
"none"
|
|
2567
|
+
],
|
|
2568
|
+
"description": "Style variant\n- **none** yields a grid whose grid items are spaced without any gutter in between\n- **sm** yields a grid whose grid items are spaced with a gap smaller than the default\n- **lg** yields a grid whose grid items are spaced with a gap larger than the default"
|
|
2569
|
+
},
|
|
2570
|
+
"break": {
|
|
2571
|
+
"type": "string",
|
|
2572
|
+
"values": [
|
|
2573
|
+
"faster",
|
|
2574
|
+
"slower"
|
|
2575
|
+
],
|
|
2576
|
+
"description": "Break variant\n- **faster** breaks the grid at a smaller width than the default.\n Example: 2up grid breaks to 2 per row at smaller width than default\n- **slower** breaks the grid at a larger width than the default.\n Example: 2up grid breaks to 2 per row at larger width than default\n- **lg** yields a grid whose grid items are spaced with a gap larger than the default"
|
|
2577
|
+
}
|
|
2578
|
+
},
|
|
2579
|
+
"properties": {},
|
|
2580
|
+
"slots": {
|
|
2581
|
+
"default": {
|
|
2582
|
+
"description": "The grid items"
|
|
2583
|
+
}
|
|
2584
|
+
},
|
|
2585
|
+
"events": {},
|
|
2586
|
+
"cssProperties": {},
|
|
2587
|
+
"examples": [
|
|
2588
|
+
{
|
|
2589
|
+
"description": "Side By Side grid",
|
|
2590
|
+
"html": "<cre8-grid variant=\"side-by-side\"></cre8-grid>"
|
|
2591
|
+
}
|
|
2592
|
+
]
|
|
2593
|
+
},
|
|
2594
|
+
{
|
|
2595
|
+
"name": "cre8-grid-item",
|
|
2596
|
+
"category": "Layout",
|
|
2597
|
+
"description": "Grid Item component.",
|
|
2598
|
+
"attributes": {},
|
|
2599
|
+
"properties": {},
|
|
2600
|
+
"slots": {
|
|
2601
|
+
"default": {
|
|
2602
|
+
"description": "The content of the grid item"
|
|
2603
|
+
}
|
|
2604
|
+
},
|
|
2605
|
+
"events": {},
|
|
2606
|
+
"cssProperties": {},
|
|
2607
|
+
"examples": []
|
|
2608
|
+
},
|
|
2609
|
+
{
|
|
2610
|
+
"name": "cre8-hero",
|
|
2611
|
+
"category": "Layout",
|
|
2612
|
+
"description": "Hero component.",
|
|
2613
|
+
"attributes": {
|
|
2614
|
+
"align": {
|
|
2615
|
+
"type": "string",
|
|
2616
|
+
"values": [
|
|
2617
|
+
"center",
|
|
2618
|
+
"left",
|
|
2619
|
+
"right",
|
|
2620
|
+
"top-left",
|
|
2621
|
+
"top-center",
|
|
2622
|
+
"bottom-center",
|
|
2623
|
+
"top-right",
|
|
2624
|
+
"bottom-right"
|
|
2625
|
+
],
|
|
2626
|
+
"description": "Position variant. Bottom left is the default position\n<cre8-text-passage size=\"sm\">\n<ul>\n<li>**top-left** renders content in the top left corner of the image</li>\n<li>**left** renders content in the left, center part of the image</li>\n<li>**top-center** renders content in the top, center part of the image</li>\n<li>**center** renders content center of the image</li>\n<li>**bottom-center** renders content bottom center of the image</li>\n<li>**top-right** renders content top-right of the image</li>\n<li>**right** renders content right of the image</li>\n<li>**bottom-right** renders content bottom, right part of the image</li>\n</ul>\n</cre8-text-passage>"
|
|
2627
|
+
}
|
|
2628
|
+
},
|
|
2629
|
+
"properties": {
|
|
2630
|
+
"imgSrc": {
|
|
2631
|
+
"type": "string",
|
|
2632
|
+
"description": "Image source"
|
|
2633
|
+
},
|
|
2634
|
+
"imgAlt": {
|
|
2635
|
+
"type": "string",
|
|
2636
|
+
"description": "Image alt text"
|
|
2637
|
+
}
|
|
2638
|
+
},
|
|
2639
|
+
"slots": {
|
|
2640
|
+
"default": {
|
|
2641
|
+
"description": "The component content"
|
|
2642
|
+
}
|
|
2643
|
+
},
|
|
2644
|
+
"events": {},
|
|
2645
|
+
"cssProperties": {},
|
|
2646
|
+
"examples": []
|
|
2647
|
+
},
|
|
2648
|
+
{
|
|
2649
|
+
"name": "cre8-layout",
|
|
2650
|
+
"category": "Layout",
|
|
2651
|
+
"description": "Layout component.",
|
|
2652
|
+
"attributes": {
|
|
2653
|
+
"variant": {
|
|
2654
|
+
"type": "\"left-sidebar\"",
|
|
2655
|
+
"description": "Style variants\n<cre8-text-passage size=\"sm\">\n<ul>\n<li>Default is a right sidebar</li>\n<li>**left-sidebar** formats the first `layout-section` component as a left sidebar</li>\n</ul>\n</cre8-text-passage>"
|
|
2656
|
+
}
|
|
2657
|
+
},
|
|
2658
|
+
"properties": {},
|
|
2659
|
+
"slots": {
|
|
2660
|
+
"default": {
|
|
2661
|
+
"description": "The layout content"
|
|
2662
|
+
}
|
|
2663
|
+
},
|
|
2664
|
+
"events": {},
|
|
2665
|
+
"cssProperties": {},
|
|
2666
|
+
"examples": []
|
|
2667
|
+
},
|
|
2668
|
+
{
|
|
2669
|
+
"name": "cre8-layout-container",
|
|
2670
|
+
"category": "Layout",
|
|
2671
|
+
"description": "Layout Container component.",
|
|
2672
|
+
"attributes": {},
|
|
2673
|
+
"properties": {
|
|
2674
|
+
"fullHeight": {
|
|
2675
|
+
"type": "boolean",
|
|
2676
|
+
"description": "Full height variant\n1) Sets the height to 100%"
|
|
2677
|
+
}
|
|
2678
|
+
},
|
|
2679
|
+
"slots": {
|
|
2680
|
+
"default": {
|
|
2681
|
+
"description": "The contents of the layout container"
|
|
2682
|
+
}
|
|
2683
|
+
},
|
|
2684
|
+
"events": {},
|
|
2685
|
+
"cssProperties": {},
|
|
2686
|
+
"examples": []
|
|
2687
|
+
},
|
|
2688
|
+
{
|
|
2689
|
+
"name": "cre8-layout-section",
|
|
2690
|
+
"category": "Layout",
|
|
2691
|
+
"description": "Layout Section component.",
|
|
2692
|
+
"attributes": {
|
|
2693
|
+
"behavior": {
|
|
2694
|
+
"type": "\"sticky\"",
|
|
2695
|
+
"description": "Behavioral variants\n- **sticky** allows the layout section to stick to the screen until the\n section reaches the bottom of the layout or the next layout section."
|
|
2696
|
+
},
|
|
2697
|
+
"top": {
|
|
2698
|
+
"type": "string",
|
|
2699
|
+
"default": "1rem",
|
|
2700
|
+
"description": "Top style\n1) Used to create dynamic sticky containers that can be adjusted based on the content"
|
|
2701
|
+
}
|
|
2702
|
+
},
|
|
2703
|
+
"properties": {},
|
|
2704
|
+
"slots": {
|
|
2705
|
+
"default": {
|
|
2706
|
+
"description": "The content of the layout section"
|
|
2707
|
+
}
|
|
2708
|
+
},
|
|
2709
|
+
"events": {},
|
|
2710
|
+
"cssProperties": {},
|
|
2711
|
+
"examples": []
|
|
2712
|
+
},
|
|
2713
|
+
{
|
|
2714
|
+
"name": "cre8-linelength-container",
|
|
2715
|
+
"category": "Layout",
|
|
2716
|
+
"description": "Linelength Container component.",
|
|
2717
|
+
"attributes": {},
|
|
2718
|
+
"properties": {},
|
|
2719
|
+
"slots": {
|
|
2720
|
+
"default": {
|
|
2721
|
+
"description": "The component content"
|
|
2722
|
+
}
|
|
2723
|
+
},
|
|
2724
|
+
"events": {},
|
|
2725
|
+
"cssProperties": {},
|
|
2726
|
+
"examples": []
|
|
2727
|
+
},
|
|
2728
|
+
{
|
|
2729
|
+
"name": "cre8-main",
|
|
2730
|
+
"category": "Layout",
|
|
2731
|
+
"description": "Main component.",
|
|
2732
|
+
"attributes": {},
|
|
2733
|
+
"properties": {
|
|
2734
|
+
"fullHeight": {
|
|
2735
|
+
"type": "boolean",
|
|
2736
|
+
"description": "Full height variant\n1) Sets the height to 100%"
|
|
2737
|
+
}
|
|
2738
|
+
},
|
|
2739
|
+
"slots": {
|
|
2740
|
+
"default": {
|
|
2741
|
+
"description": "The main content"
|
|
2742
|
+
}
|
|
2743
|
+
},
|
|
2744
|
+
"events": {},
|
|
2745
|
+
"cssProperties": {},
|
|
2746
|
+
"examples": []
|
|
2747
|
+
},
|
|
2748
|
+
{
|
|
2749
|
+
"name": "cre8-section",
|
|
2750
|
+
"category": "Layout",
|
|
2751
|
+
"description": "The section component acts as a block level HTML element that takes a 'headline' property\nthat renders the section's heading which wraps around any HTML template\nthat is found under this heading in the page layout.\n\n# How to Use\n1. Use the headline attribute to create the section header, or if you need a more custom header\n there is a slot=\"header\" that you can target for inserting a custom template.\n2. For the main body contents, any html template can be placed inside the cre8-section component\n and will automatically render below the header.\n\nNote: for a section with a dark background please control this with the internal Components' inverted attributes.",
|
|
2752
|
+
"attributes": {
|
|
2753
|
+
"headline": {
|
|
2754
|
+
"type": "string",
|
|
2755
|
+
"description": "The Headline will be rendered as the Section Headline with the correct brand styling applied"
|
|
2756
|
+
}
|
|
2757
|
+
},
|
|
2758
|
+
"properties": {},
|
|
2759
|
+
"slots": {
|
|
2760
|
+
"default": {
|
|
2761
|
+
"description": "The content of the section should go here.\nIt could be a cre8-text-passage, a cre8-card or any other block level html."
|
|
2762
|
+
}
|
|
2763
|
+
},
|
|
2764
|
+
"events": {},
|
|
2765
|
+
"cssProperties": {},
|
|
2766
|
+
"examples": []
|
|
2767
|
+
},
|
|
2768
|
+
{
|
|
2769
|
+
"name": "cre8-feature",
|
|
2770
|
+
"category": "Marketing",
|
|
2771
|
+
"description": "Feature component.",
|
|
2772
|
+
"attributes": {
|
|
2773
|
+
"inverted": {
|
|
2774
|
+
"type": "boolean",
|
|
2775
|
+
"description": "Inverted variant\n1) Used for dark backgrounds"
|
|
2776
|
+
}
|
|
2777
|
+
},
|
|
2778
|
+
"properties": {
|
|
2779
|
+
"imgSrc": {
|
|
2780
|
+
"type": "string",
|
|
2781
|
+
"description": "Image source"
|
|
2782
|
+
},
|
|
2783
|
+
"imgAlt": {
|
|
2784
|
+
"type": "string",
|
|
2785
|
+
"description": "Image alt text"
|
|
2786
|
+
}
|
|
2787
|
+
},
|
|
2788
|
+
"slots": {
|
|
2789
|
+
"default": {
|
|
2790
|
+
"description": "The component content"
|
|
2791
|
+
}
|
|
2792
|
+
},
|
|
2793
|
+
"events": {},
|
|
2794
|
+
"cssProperties": {},
|
|
2795
|
+
"examples": []
|
|
2796
|
+
},
|
|
2797
|
+
{
|
|
2798
|
+
"name": "cre8-page-header",
|
|
2799
|
+
"category": "Marketing",
|
|
2800
|
+
"description": "Page Header component.",
|
|
2801
|
+
"attributes": {
|
|
2802
|
+
"heading": {
|
|
2803
|
+
"type": "string",
|
|
2804
|
+
"default": "Page header title",
|
|
2805
|
+
"description": "Page header title"
|
|
2806
|
+
}
|
|
2807
|
+
},
|
|
2808
|
+
"properties": {},
|
|
2809
|
+
"slots": {
|
|
2810
|
+
"default": {
|
|
2811
|
+
"description": "The page header content"
|
|
2812
|
+
}
|
|
2813
|
+
},
|
|
2814
|
+
"events": {},
|
|
2815
|
+
"cssProperties": {},
|
|
2816
|
+
"examples": []
|
|
2817
|
+
},
|
|
2818
|
+
{
|
|
2819
|
+
"name": "cre8-icon",
|
|
2820
|
+
"category": "Media",
|
|
2821
|
+
"description": "\n<svg> is a web component, which can be used with any frontend framework and use any svg.\nIt takes raw svgs as props and renders them.\n\n**'svg-legacy'** will be **deprecated** in Web Components v0.5.0\n\n- [List of new figma icons](https:/www.figma.com/file/j1a0rBkoH65XiGKfq7ppWa/Iconography?type=design&node-id=2037-5773&mode=design&t=6ZzC6KH3Gkxf3fj5-4)\n- The new `svg` from the svg package: https:/static-dev.esi-memberweb-dev.aws.evernorthcloud.com/svgs/.\n\n##Usability Considerations\n- If the icon is decorative: set `aria-hidden` to true.\n- If the icon is interactive (not decorative): set `aria-hidden` to false and add the `aria-label`\n- If the icon is key to functionality from a screen reader perspective, it is required to add `aria-label`\nwhich will describe the icon.\nFor example, if the icon is a close button, setting `aria-label=\"Close\"`will give\nthe SVG an aria-label to make it sufficiently accessible.\n\n[More information on Accessibility with svgs](https:/static-dev.esi-memberweb-dev.aws.evernorthcloud.com/svgs/?path=/story/getting-started-accessibility--page)\n\n##How to use\nCre8 Web Components (cre8-wc) includes the `cre8_dev/svgs` package.\nIf you need to install a newer version than what's included, please see\nthe [installation instructions for svgs](https:/git.express-scripts.com/ExpressScripts/svgs#installation).\n- Import the component (this is the icon container): `import '@cre8_dev/svgs';`\n- Import an svg as a string: `import svgInfo from 'cre8_dev/svgs/lib/icons/System/Regular/Info.svg?raw';`\n\nYour import paths may be different depending on your project's build configuration.\nPlease see [Importing Icons](https:/static-dev.esi-memberweb-dev.aws.evernorthcloud.com/svgs/?path=/story/icon-sets-importing-icons--page)\nof the `cre8_dev/svgs` documentation for more information.",
|
|
2822
|
+
"attributes": {
|
|
2823
|
+
"focusable": {
|
|
2824
|
+
"type": "boolean",
|
|
2825
|
+
"description": "Focusable"
|
|
2826
|
+
},
|
|
2827
|
+
"name": {
|
|
2828
|
+
"type": "string",
|
|
2829
|
+
"description": "Icon name (this method of passing in svgs is to be deprecated)"
|
|
2830
|
+
},
|
|
2831
|
+
"svg": {
|
|
2832
|
+
"type": "string"
|
|
2833
|
+
}
|
|
2834
|
+
},
|
|
2835
|
+
"properties": {
|
|
2836
|
+
"iconUrl": {
|
|
2837
|
+
"type": "string",
|
|
2838
|
+
"default": "iconSprite",
|
|
2839
|
+
"description": "Icon path\n1) This points to the file where the icon sprite lives\n2) This method of pathing will soon be depricated"
|
|
2840
|
+
},
|
|
2841
|
+
"iconTitle": {
|
|
2842
|
+
"type": "string",
|
|
2843
|
+
"description": "Icon Title, this string is used for the aira-label of the svg"
|
|
2844
|
+
}
|
|
2845
|
+
},
|
|
2846
|
+
"slots": {},
|
|
2847
|
+
"events": {},
|
|
2848
|
+
"cssProperties": {},
|
|
2849
|
+
"examples": []
|
|
2850
|
+
},
|
|
2851
|
+
{
|
|
2852
|
+
"name": "cre8-logo",
|
|
2853
|
+
"category": "Media",
|
|
2854
|
+
"description": "Logo component.",
|
|
2855
|
+
"attributes": {
|
|
2856
|
+
"href": {
|
|
2857
|
+
"type": "string",
|
|
2858
|
+
"description": "Logo link"
|
|
2859
|
+
}
|
|
2860
|
+
},
|
|
2861
|
+
"properties": {},
|
|
2862
|
+
"slots": {
|
|
2863
|
+
"default": {
|
|
2864
|
+
"description": "The logo element"
|
|
2865
|
+
}
|
|
2866
|
+
},
|
|
2867
|
+
"events": {},
|
|
2868
|
+
"cssProperties": {},
|
|
2869
|
+
"examples": []
|
|
2870
|
+
},
|
|
2871
|
+
{
|
|
2872
|
+
"name": "cre8-breadcrumbs",
|
|
2873
|
+
"category": "Navigation",
|
|
2874
|
+
"description": "The breadcrumbs component is a secondary navigation pattern that helps a user understand where the user is located.\nThe breadcrumbs component shows the users their current location relative to the information architecture\nIt enables the users to quickly move up to a parent level or previous location.\n\n## How to Use\n\n- Import 'Breadcrumbs' component.\n- Add the pages in the path of the breadcrumbs using `cre8-breadcrumbs-item`.\nAll the pages in the breadcrumbs component should be interactive.\n- All the page should link to their respective pages (except the current page) using `cre8-link`.\n- The current page is included in the breadcrumbs trail.\n- The current page is always the last text listed and is not an interactive link.",
|
|
2875
|
+
"attributes": {},
|
|
2876
|
+
"properties": {
|
|
2877
|
+
"navAriaLabel": {
|
|
2878
|
+
"type": "string",
|
|
2879
|
+
"default": "breadcrumbs",
|
|
2880
|
+
"description": "aria-label attribute to designate at name for the nav. Can be override by user"
|
|
2881
|
+
}
|
|
2882
|
+
},
|
|
2883
|
+
"slots": {
|
|
2884
|
+
"default": {
|
|
2885
|
+
"description": "The component content"
|
|
2886
|
+
}
|
|
2887
|
+
},
|
|
2888
|
+
"events": {},
|
|
2889
|
+
"cssProperties": {},
|
|
2890
|
+
"examples": []
|
|
2891
|
+
},
|
|
2892
|
+
{
|
|
2893
|
+
"name": "cre8-breadcrumbs-item",
|
|
2894
|
+
"category": "Navigation",
|
|
2895
|
+
"description": "Breadcrumbs Item component.",
|
|
2896
|
+
"attributes": {},
|
|
2897
|
+
"properties": {},
|
|
2898
|
+
"slots": {
|
|
2899
|
+
"default": {
|
|
2900
|
+
"description": "The component content, the expected slotted content is a Cre8 Link or a String for the \"terminal node\""
|
|
2901
|
+
}
|
|
2902
|
+
},
|
|
2903
|
+
"events": {},
|
|
2904
|
+
"cssProperties": {},
|
|
2905
|
+
"examples": []
|
|
2906
|
+
},
|
|
2907
|
+
{
|
|
2908
|
+
"name": "cre8-footer",
|
|
2909
|
+
"category": "Navigation",
|
|
2910
|
+
"description": "Footer component.",
|
|
2911
|
+
"attributes": {},
|
|
2912
|
+
"properties": {},
|
|
2913
|
+
"slots": {
|
|
2914
|
+
"default": {
|
|
2915
|
+
"description": "The footer content"
|
|
2916
|
+
},
|
|
2917
|
+
"top": {
|
|
2918
|
+
"description": "The top content (above the default slot)"
|
|
2919
|
+
},
|
|
2920
|
+
"bottom": {
|
|
2921
|
+
"description": "The bottom content (below the default slot)"
|
|
2922
|
+
}
|
|
2923
|
+
},
|
|
2924
|
+
"events": {},
|
|
2925
|
+
"cssProperties": {},
|
|
2926
|
+
"examples": []
|
|
2927
|
+
},
|
|
2928
|
+
{
|
|
2929
|
+
"name": "cre8-global-nav",
|
|
2930
|
+
"category": "Navigation",
|
|
2931
|
+
"description": "Global Nav component.",
|
|
2932
|
+
"attributes": {
|
|
2933
|
+
"inverted": {
|
|
2934
|
+
"type": "boolean",
|
|
2935
|
+
"description": "Inverted variant\n1) Used for dark backgrounds"
|
|
2936
|
+
},
|
|
2937
|
+
"behavior": {
|
|
2938
|
+
"type": "\"side-by-side\"",
|
|
2939
|
+
"description": "Behavior variant\n<cre8-text-passage size=\"sm\">\n<ul>\n<li>**side-by-side** keeps the primary nav item always in a horizontal pattern</li>\n</ul>\n</cre8-text-passage>"
|
|
2940
|
+
}
|
|
2941
|
+
},
|
|
2942
|
+
"properties": {
|
|
2943
|
+
"navAriaLabel": {
|
|
2944
|
+
"type": "string",
|
|
2945
|
+
"default": "global",
|
|
2946
|
+
"description": "aria-label attribute to designate at name for the nav. Can be override by user"
|
|
2947
|
+
}
|
|
2948
|
+
},
|
|
2949
|
+
"slots": {
|
|
2950
|
+
"default": {
|
|
2951
|
+
"description": "The primary navigation items"
|
|
2952
|
+
}
|
|
2953
|
+
},
|
|
2954
|
+
"events": {},
|
|
2955
|
+
"cssProperties": {},
|
|
2956
|
+
"examples": []
|
|
2957
|
+
},
|
|
2958
|
+
{
|
|
2959
|
+
"name": "cre8-global-nav-item",
|
|
2960
|
+
"category": "Navigation",
|
|
2961
|
+
"description": "Global Nav Item component.",
|
|
2962
|
+
"attributes": {
|
|
2963
|
+
"text": {
|
|
2964
|
+
"type": "string",
|
|
2965
|
+
"default": "Nav item",
|
|
2966
|
+
"description": "Primary nav item text"
|
|
2967
|
+
},
|
|
2968
|
+
"href": {
|
|
2969
|
+
"type": "string",
|
|
2970
|
+
"default": "#",
|
|
2971
|
+
"description": "Primary nav item href"
|
|
2972
|
+
}
|
|
2973
|
+
},
|
|
2974
|
+
"properties": {
|
|
2975
|
+
"iconName": {
|
|
2976
|
+
"type": "string",
|
|
2977
|
+
"default": "keyboard-arrow-down",
|
|
2978
|
+
"description": "Icon name"
|
|
2979
|
+
},
|
|
2980
|
+
"megaMenu": {
|
|
2981
|
+
"type": "boolean",
|
|
2982
|
+
"description": "Append to the class name. Used for passing in utility classes"
|
|
2983
|
+
},
|
|
2984
|
+
"isActive": {
|
|
2985
|
+
"type": "boolean",
|
|
2986
|
+
"description": "Append to the class name. Used for passing in utility classes"
|
|
2987
|
+
}
|
|
2988
|
+
},
|
|
2989
|
+
"slots": {
|
|
2990
|
+
"default": {
|
|
2991
|
+
"description": "The label for the navigation item"
|
|
2992
|
+
}
|
|
2993
|
+
},
|
|
2994
|
+
"events": {},
|
|
2995
|
+
"cssProperties": {},
|
|
2996
|
+
"examples": [
|
|
2997
|
+
{
|
|
2998
|
+
"description": "Basic global-nav-item",
|
|
2999
|
+
"html": "<cre8-global-nav-item text=\"Global Nav Item\"></cre8-global-nav-item>"
|
|
3000
|
+
}
|
|
3001
|
+
]
|
|
3002
|
+
},
|
|
3003
|
+
{
|
|
3004
|
+
"name": "cre8-header",
|
|
3005
|
+
"category": "Navigation",
|
|
3006
|
+
"description": "Header component.",
|
|
3007
|
+
"attributes": {},
|
|
3008
|
+
"properties": {
|
|
3009
|
+
"isActive": {
|
|
3010
|
+
"type": "boolean",
|
|
3011
|
+
"description": "Is active state\n1) Set to true when small screen menu is open"
|
|
3012
|
+
}
|
|
3013
|
+
},
|
|
3014
|
+
"slots": {
|
|
3015
|
+
"default": {
|
|
3016
|
+
"description": "The header content"
|
|
3017
|
+
}
|
|
3018
|
+
},
|
|
3019
|
+
"events": {},
|
|
3020
|
+
"cssProperties": {},
|
|
3021
|
+
"examples": []
|
|
3022
|
+
},
|
|
3023
|
+
{
|
|
3024
|
+
"name": "cre8-link",
|
|
3025
|
+
"category": "Navigation",
|
|
3026
|
+
"description": "Link Component are strictly used in the case where the component will take\nthe user away from the current page to a new url.\nIn this vein, this component should ONLY be used in situations an anchor tag would be used (an href is required)\nThis goes for the variations as well such as the Call To Action Link\n\n**Note**\n\nFor link with icon:\n- **iconRotateDegree** & **iconFlipDirection** props are optional.\n- They are used to set up the correct direction for icons, for example,\narrows, caret up or caret down.",
|
|
3027
|
+
"attributes": {
|
|
3028
|
+
"href": {
|
|
3029
|
+
"type": "string",
|
|
3030
|
+
"description": "Href attribute of the anchor tag"
|
|
3031
|
+
},
|
|
3032
|
+
"rel": {
|
|
3033
|
+
"type": "string",
|
|
3034
|
+
"description": "Rel attribute of the anchor tag"
|
|
3035
|
+
},
|
|
3036
|
+
"target": {
|
|
3037
|
+
"type": "string",
|
|
3038
|
+
"values": [
|
|
3039
|
+
"_blank",
|
|
3040
|
+
"_self",
|
|
3041
|
+
"_parent",
|
|
3042
|
+
"_top"
|
|
3043
|
+
],
|
|
3044
|
+
"description": "Target attribute for a link (i.e. set to _blank to open in new tab)\n- **_blank** yields a link that opens in a new tab\n- **_self** yields a link that loads the URL into the same browsing context as the current one.\n This is the default behavior\n- **_parent** yields a link that loads the URL into the parent browsing context of the current one.\n If there is no parent, this behaves the same way as _self\n- **_top** yields a link that loads the URL into the top-level browsing context.\n If there is no parent, this behaves the same way as _self."
|
|
3045
|
+
},
|
|
3046
|
+
"svg": {
|
|
3047
|
+
"type": "string",
|
|
3048
|
+
"description": "svg as a raw string\n- For links with icon, the icon is defined by this prop.\n- Pass in a raw svg as a String for using <cre8-icon>"
|
|
3049
|
+
},
|
|
3050
|
+
"size": {
|
|
3051
|
+
"type": "string",
|
|
3052
|
+
"values": [
|
|
3053
|
+
"sm",
|
|
3054
|
+
"lg"
|
|
3055
|
+
],
|
|
3056
|
+
"description": "Size variant (default is medium)\n- **sm** shrinks the link typography and overall size\n- **lg** increases the link typography size and overall size"
|
|
3057
|
+
},
|
|
3058
|
+
"inverted": {
|
|
3059
|
+
"type": "boolean",
|
|
3060
|
+
"description": "Inverted colors Link (onDark)"
|
|
3061
|
+
}
|
|
3062
|
+
},
|
|
3063
|
+
"properties": {
|
|
3064
|
+
"iconName": {
|
|
3065
|
+
"type": "string",
|
|
3066
|
+
"description": "DEPRECATED: Icon name, use svg instead"
|
|
3067
|
+
},
|
|
3068
|
+
"iconRotateDegree": {
|
|
3069
|
+
"type": "number",
|
|
3070
|
+
"default": 0,
|
|
3071
|
+
"description": "iconRotateDegree is used for <cre8-icon> to set the arrow in the correct direction"
|
|
3072
|
+
},
|
|
3073
|
+
"iconFlipDirection": {
|
|
3074
|
+
"type": "string",
|
|
3075
|
+
"description": "iconFlipDirection is used for <cre8-icon> to set the icon in the correct direction"
|
|
3076
|
+
},
|
|
3077
|
+
"iconPosition": {
|
|
3078
|
+
"type": "string",
|
|
3079
|
+
"values": [
|
|
3080
|
+
"before",
|
|
3081
|
+
"after"
|
|
3082
|
+
],
|
|
3083
|
+
"default": "undefined",
|
|
3084
|
+
"description": "Icon position\n- **before** places the icon before the button text\n- **after** places the icon after the button text"
|
|
3085
|
+
},
|
|
3086
|
+
"ctaIcon": {
|
|
3087
|
+
"type": "string",
|
|
3088
|
+
"default": "arrow-forward",
|
|
3089
|
+
"description": "Call To Action Icon"
|
|
3090
|
+
},
|
|
3091
|
+
"ctaLink": {
|
|
3092
|
+
"type": "boolean",
|
|
3093
|
+
"description": "Call To Action Link"
|
|
3094
|
+
},
|
|
3095
|
+
"noUnderline": {
|
|
3096
|
+
"type": "boolean",
|
|
3097
|
+
"description": "Link with no underline"
|
|
3098
|
+
}
|
|
3099
|
+
},
|
|
3100
|
+
"slots": {},
|
|
3101
|
+
"events": {},
|
|
3102
|
+
"cssProperties": {},
|
|
3103
|
+
"examples": []
|
|
3104
|
+
},
|
|
3105
|
+
{
|
|
3106
|
+
"name": "cre8-link-list",
|
|
3107
|
+
"category": "Navigation",
|
|
3108
|
+
"description": "Link List component.",
|
|
3109
|
+
"attributes": {
|
|
3110
|
+
"behavior": {
|
|
3111
|
+
"type": "string",
|
|
3112
|
+
"values": [
|
|
3113
|
+
"horizontal",
|
|
3114
|
+
"responsive"
|
|
3115
|
+
],
|
|
3116
|
+
"description": "Behavioral variant\n- **responsive** renders a horizontal wrapping link list that converts to a stacked link list on large screens\n- **horizontal** renders a horizontal wrapping link list on all screens"
|
|
3117
|
+
},
|
|
3118
|
+
"inverted": {
|
|
3119
|
+
"type": "boolean",
|
|
3120
|
+
"description": "Inverted variant\n1. Used for dark backgrounds"
|
|
3121
|
+
},
|
|
3122
|
+
"size": {
|
|
3123
|
+
"type": "\"sm\"",
|
|
3124
|
+
"description": "Size variants\n- **sm** renders a link list with a smaller typography"
|
|
3125
|
+
},
|
|
3126
|
+
"spacing": {
|
|
3127
|
+
"type": "\"condensed\"",
|
|
3128
|
+
"description": "Spacing between link list items\n- **condensed** renders a link list with a more compact display"
|
|
3129
|
+
},
|
|
3130
|
+
"variant": {
|
|
3131
|
+
"type": "string",
|
|
3132
|
+
"values": [
|
|
3133
|
+
"secondary",
|
|
3134
|
+
"display"
|
|
3135
|
+
],
|
|
3136
|
+
"description": "Style variants\n- **secondary** renders a link list with a more subtle visual treatment\n- **display** renders a link list with a display treatment (e.g. article title)"
|
|
3137
|
+
}
|
|
3138
|
+
},
|
|
3139
|
+
"properties": {},
|
|
3140
|
+
"slots": {
|
|
3141
|
+
"default": {
|
|
3142
|
+
"description": "The link list items"
|
|
3143
|
+
}
|
|
3144
|
+
},
|
|
3145
|
+
"events": {},
|
|
3146
|
+
"cssProperties": {},
|
|
3147
|
+
"examples": [
|
|
3148
|
+
{
|
|
3149
|
+
"description": "Secondary link-list",
|
|
3150
|
+
"html": "<cre8-link-list variant=\"secondary\"></cre8-link-list>"
|
|
3151
|
+
}
|
|
3152
|
+
]
|
|
3153
|
+
},
|
|
3154
|
+
{
|
|
3155
|
+
"name": "cre8-link-list-item",
|
|
3156
|
+
"category": "Navigation",
|
|
3157
|
+
"description": "Link List Item component.",
|
|
3158
|
+
"attributes": {
|
|
3159
|
+
"text": {
|
|
3160
|
+
"type": "string",
|
|
3161
|
+
"description": "The link text"
|
|
3162
|
+
},
|
|
3163
|
+
"href": {
|
|
3164
|
+
"type": "string",
|
|
3165
|
+
"description": "The link URL"
|
|
3166
|
+
}
|
|
3167
|
+
},
|
|
3168
|
+
"properties": {
|
|
3169
|
+
"isActive": {
|
|
3170
|
+
"type": "boolean",
|
|
3171
|
+
"description": "Active link"
|
|
3172
|
+
}
|
|
3173
|
+
},
|
|
3174
|
+
"slots": {
|
|
3175
|
+
"default": {
|
|
3176
|
+
"description": "The default slot to put badges or other Components"
|
|
3177
|
+
}
|
|
3178
|
+
},
|
|
3179
|
+
"events": {},
|
|
3180
|
+
"cssProperties": {},
|
|
3181
|
+
"examples": [
|
|
3182
|
+
{
|
|
3183
|
+
"description": "Basic link-list-item",
|
|
3184
|
+
"html": "<cre8-link-list-item text=\"Link List Item\"></cre8-link-list-item>"
|
|
3185
|
+
}
|
|
3186
|
+
]
|
|
3187
|
+
},
|
|
3188
|
+
{
|
|
3189
|
+
"name": "cre8-nav-container",
|
|
3190
|
+
"category": "Navigation",
|
|
3191
|
+
"description": "Nav Container component.",
|
|
3192
|
+
"attributes": {},
|
|
3193
|
+
"properties": {},
|
|
3194
|
+
"slots": {
|
|
3195
|
+
"default": {
|
|
3196
|
+
"description": "The navigation container content"
|
|
3197
|
+
}
|
|
3198
|
+
},
|
|
3199
|
+
"events": {},
|
|
3200
|
+
"cssProperties": {},
|
|
3201
|
+
"examples": []
|
|
3202
|
+
},
|
|
3203
|
+
{
|
|
3204
|
+
"name": "cre8-pagination",
|
|
3205
|
+
"category": "Navigation",
|
|
3206
|
+
"description": "The Pagination component is used to split up a large amount of results\n by showing only a certain amount on each page. You can cycle through\n the pages using Page Numbers, Next and Previous Buttons, or optional\n First Page and Last Page Buttons. This component is also used by Table\n to cycle through rows of results. Pagination has 3 display options:\n\n**default**: Can contain up to seven Page Numbers (ellipses included)\n at a time flanked by Next and Previous Buttons. When there are more than\n seven pages, numbers start getting replaced by ellipses. Use this option\n when you have a lot of horizontal space in a layout. It should not be used\n for mobile web layouts since its buttons are smaller than the minimum touch target of 44px.\n The component has built in responsivity to mobile page size so you dont have tohandle this\n seperately\n\n\n**compact** : Best used as a summary of where you are among pages or table rows flanked by\nPrevious and Next Buttons. Use this option when you have limited horizontal space but still\nneed to show where users are among results. Great for mobile layouts.\n\n\n**icon-only** : Use this option in very tight spaces when it’s not required to show users\nwhere they are among results. Great for mobile layouts.\n\n\n## HOW TO USE\n\nSelect an option from the “display” dropdown depending on layout width\nSelect where your current page is from the “Page” dropdown\nTo show less pages when using Full Numbers, use the \"visiblePages” toggles\nTo hide the First Page and Last Page Buttons, turn on the “hideFirstLastButton” toggle\nTo change the states of page numbers or buttons, interact with the buttond to invoke each “State”\nWhen using Compact Numbers, you can choose between “compact” and “icon-only” formats\n\n\n## ACCESSIBILITY NOTE\n\nTo best orient people using screen readers, push focus to the top of\nthe list of results after any of the pagination buttons have been triggered,\n**except for the currently selected one**. Focus target could be a visual results heading,\nor the top heading of the results container of the page selected\nvia a programmatic selector, e.g. < section id=“results” aria-label=\"results-section\" > or\n< div role= “group” aria-label=“results” >.",
|
|
3207
|
+
"attributes": {
|
|
3208
|
+
"display": {
|
|
3209
|
+
"type": "string",
|
|
3210
|
+
"values": [
|
|
3211
|
+
"compact",
|
|
3212
|
+
"icon-only",
|
|
3213
|
+
"default"
|
|
3214
|
+
],
|
|
3215
|
+
"description": "(optional) prop that allows for a compact and icon-only variant both\nfor mobile screen-sizes and for use in certain contexts as guided by design,\nthe component size will show 'default' in the absence of a value on desktop and\n'compact' on smaller views."
|
|
3216
|
+
}
|
|
3217
|
+
},
|
|
3218
|
+
"properties": {
|
|
3219
|
+
"totalResults": {
|
|
3220
|
+
"type": "number",
|
|
3221
|
+
"description": "Input the total number of elements are returned from consuming app e.g. search results"
|
|
3222
|
+
},
|
|
3223
|
+
"pageSize": {
|
|
3224
|
+
"type": "number",
|
|
3225
|
+
"description": "how many elements will displayVariant per page, indicated by business to typically be 20"
|
|
3226
|
+
},
|
|
3227
|
+
"visiblePages": {
|
|
3228
|
+
"type": "number",
|
|
3229
|
+
"default": 5,
|
|
3230
|
+
"description": "Controls how many page buttons are displayVarianted on the page\nat once, if container size permits. recommended max = 5 pages"
|
|
3231
|
+
},
|
|
3232
|
+
"hideLastAndFirstButtons": {
|
|
3233
|
+
"type": "boolean"
|
|
3234
|
+
},
|
|
3235
|
+
"currentPage": {
|
|
3236
|
+
"type": "number"
|
|
3237
|
+
},
|
|
3238
|
+
"elementDefinitions": {
|
|
3239
|
+
"type": "{ 'cre8-button': typeof Cre8Button; }"
|
|
3240
|
+
},
|
|
3241
|
+
"windowWidth": {
|
|
3242
|
+
"type": "number"
|
|
3243
|
+
},
|
|
3244
|
+
"buttons": {
|
|
3245
|
+
"type": "(typeof Cre8Button)[]"
|
|
3246
|
+
},
|
|
3247
|
+
"maxVisiblePages": {
|
|
3248
|
+
"type": "number"
|
|
3249
|
+
}
|
|
3250
|
+
},
|
|
3251
|
+
"slots": {},
|
|
3252
|
+
"events": {
|
|
3253
|
+
"pagination.click": {
|
|
3254
|
+
"detail": {}
|
|
3255
|
+
}
|
|
3256
|
+
},
|
|
3257
|
+
"cssProperties": {
|
|
3258
|
+
"--pagination-display": {
|
|
3259
|
+
"description": "controls the display css property"
|
|
3260
|
+
},
|
|
3261
|
+
"--pagination-justify-content": {
|
|
3262
|
+
"description": "controls horizontal alignment of pagination"
|
|
3263
|
+
},
|
|
3264
|
+
"--pagination-align-items": {
|
|
3265
|
+
"description": "controls vertical alignment of pagination"
|
|
3266
|
+
}
|
|
3267
|
+
},
|
|
3268
|
+
"examples": []
|
|
3269
|
+
},
|
|
3270
|
+
{
|
|
3271
|
+
"name": "cre8-primary-nav",
|
|
3272
|
+
"category": "Navigation",
|
|
3273
|
+
"description": "Primary Nav component.",
|
|
3274
|
+
"attributes": {
|
|
3275
|
+
"inverted": {
|
|
3276
|
+
"type": "boolean",
|
|
3277
|
+
"description": "Inverted variant\n1) Used for dark backgrounds"
|
|
3278
|
+
},
|
|
3279
|
+
"behavior": {
|
|
3280
|
+
"type": "\"side-by-side\"",
|
|
3281
|
+
"description": "Behavior variant\n<cre8-text-passage size=\"sm\">\n<ul>\n<li>**side-by-side** keeps the primary nav item always in a horizontal pattern</li>\n</ul>\n</cre8-text-passage>"
|
|
3282
|
+
}
|
|
3283
|
+
},
|
|
3284
|
+
"properties": {
|
|
3285
|
+
"navAriaLabel": {
|
|
3286
|
+
"type": "string",
|
|
3287
|
+
"default": "main",
|
|
3288
|
+
"description": "aria-label attribute to designate at name for the nav. Can be override by user"
|
|
3289
|
+
}
|
|
3290
|
+
},
|
|
3291
|
+
"slots": {
|
|
3292
|
+
"default": {
|
|
3293
|
+
"description": "The primary navigation items"
|
|
3294
|
+
}
|
|
3295
|
+
},
|
|
3296
|
+
"events": {},
|
|
3297
|
+
"cssProperties": {},
|
|
3298
|
+
"examples": []
|
|
3299
|
+
},
|
|
3300
|
+
{
|
|
3301
|
+
"name": "cre8-primary-nav-item",
|
|
3302
|
+
"category": "Navigation",
|
|
3303
|
+
"description": "Primary Nav Item component.",
|
|
3304
|
+
"attributes": {
|
|
3305
|
+
"text": {
|
|
3306
|
+
"type": "string",
|
|
3307
|
+
"default": "Nav item",
|
|
3308
|
+
"description": "Primary nav item text"
|
|
3309
|
+
},
|
|
3310
|
+
"href": {
|
|
3311
|
+
"type": "string",
|
|
3312
|
+
"default": "#",
|
|
3313
|
+
"description": "Primary nav item href"
|
|
3314
|
+
}
|
|
3315
|
+
},
|
|
3316
|
+
"properties": {
|
|
3317
|
+
"iconName": {
|
|
3318
|
+
"type": "string",
|
|
3319
|
+
"default": "caret-down",
|
|
3320
|
+
"description": "Icon name"
|
|
3321
|
+
},
|
|
3322
|
+
"megaMenu": {
|
|
3323
|
+
"type": "boolean",
|
|
3324
|
+
"description": "Append to the class name. Used for passing in utility classes"
|
|
3325
|
+
},
|
|
3326
|
+
"isActive": {
|
|
3327
|
+
"type": "boolean",
|
|
3328
|
+
"description": "Append to the class name. Used for passing in utility classes"
|
|
3329
|
+
}
|
|
3330
|
+
},
|
|
3331
|
+
"slots": {
|
|
3332
|
+
"default": {
|
|
3333
|
+
"description": "The label for the navigation item"
|
|
3334
|
+
}
|
|
3335
|
+
},
|
|
3336
|
+
"events": {},
|
|
3337
|
+
"cssProperties": {},
|
|
3338
|
+
"examples": [
|
|
3339
|
+
{
|
|
3340
|
+
"description": "Basic primary-nav-item",
|
|
3341
|
+
"html": "<cre8-primary-nav-item text=\"Primary Nav Item\"></cre8-primary-nav-item>"
|
|
3342
|
+
}
|
|
3343
|
+
]
|
|
3344
|
+
},
|
|
3345
|
+
{
|
|
3346
|
+
"name": "cre8-tab",
|
|
3347
|
+
"category": "Navigation",
|
|
3348
|
+
"description": "Tab component.",
|
|
3349
|
+
"attributes": {
|
|
3350
|
+
"size": {
|
|
3351
|
+
"type": "\"sm\"",
|
|
3352
|
+
"description": "Tab sizes\n- **default** displays the tab text with cre8-typography-label-default\n- **sm** displays the tab text with cre8-typography-label-small and decrease padding\n\n_*This property is dynamically set_"
|
|
3353
|
+
},
|
|
3354
|
+
"index": {
|
|
3355
|
+
"type": "number",
|
|
3356
|
+
"description": "Used to align the tab with the tab panel\n\n_*This property is dynamically set_"
|
|
3357
|
+
}
|
|
3358
|
+
},
|
|
3359
|
+
"properties": {
|
|
3360
|
+
"isActive": {
|
|
3361
|
+
"type": "boolean",
|
|
3362
|
+
"description": "If is true, tab has active state and cooresponding tab panel is visible.\n\n_*This property is dynamically set_"
|
|
3363
|
+
},
|
|
3364
|
+
"ariaLabelledBy": {
|
|
3365
|
+
"type": "string",
|
|
3366
|
+
"description": "Used to connect tab trigger and tab panel for accessibility\n\n_*This property is dynamically set_"
|
|
3367
|
+
}
|
|
3368
|
+
},
|
|
3369
|
+
"slots": {
|
|
3370
|
+
"default": {
|
|
3371
|
+
"description": "The component content"
|
|
3372
|
+
}
|
|
3373
|
+
},
|
|
3374
|
+
"events": {
|
|
3375
|
+
"tabSelected": {
|
|
3376
|
+
"detail": {}
|
|
3377
|
+
}
|
|
3378
|
+
},
|
|
3379
|
+
"cssProperties": {},
|
|
3380
|
+
"examples": []
|
|
3381
|
+
},
|
|
3382
|
+
{
|
|
3383
|
+
"name": "cre8-tab-panel",
|
|
3384
|
+
"category": "Navigation",
|
|
3385
|
+
"description": "Tab Panel component.",
|
|
3386
|
+
"attributes": {
|
|
3387
|
+
"index": {
|
|
3388
|
+
"type": "number",
|
|
3389
|
+
"description": "Used to align the tab panel with the tab\n<br/><br/> _*This property is dynamically set_"
|
|
3390
|
+
}
|
|
3391
|
+
},
|
|
3392
|
+
"properties": {
|
|
3393
|
+
"skipFocusOnPanel": {
|
|
3394
|
+
"type": "boolean",
|
|
3395
|
+
"description": "This will remove focus on panel element"
|
|
3396
|
+
},
|
|
3397
|
+
"isActive": {
|
|
3398
|
+
"type": "boolean",
|
|
3399
|
+
"description": "Indicates if the panel is active\n<br/><br/> _*This property is dynamically set_"
|
|
3400
|
+
}
|
|
3401
|
+
},
|
|
3402
|
+
"slots": {
|
|
3403
|
+
"default": {
|
|
3404
|
+
"description": "The component content"
|
|
3405
|
+
}
|
|
3406
|
+
},
|
|
3407
|
+
"events": {},
|
|
3408
|
+
"cssProperties": {},
|
|
3409
|
+
"examples": []
|
|
3410
|
+
},
|
|
3411
|
+
{
|
|
3412
|
+
"name": "cre8-tabs",
|
|
3413
|
+
"category": "Navigation",
|
|
3414
|
+
"description": "Tabs are used to quickly navigate back and forth between views.\nThe Tab design and interaction varies depending on the requirements for your organization and project.\nStandardizing on the best individual controls will improve usability and reduce development and QA time.\n\nCreate a standard set of Tab controls:\nPrimary Tabs (for system navigation), Secondary Tabs (for sub navigation within a screen).\n\n## Usability Guidelines\n- The selected Tab should be visually differentiated from the other Tabs.\n The deselected Tabs should still look enabled.\n Dimming the other Tabs decreases the legibility of items that are actually active and clickable.\n- There must be a minimum of 2 Tabs.\n- Showing status in a Tab is non-standard (such as 0%, 10%).\n- Tab labels and content should be parallel, with the exception of a Summary or Overview Tab\n which can be a rollup of content across other Tabs.\n- Keep the font size of the Tabs the same.\n If the Tabs are a fixed width and one of the labels is too long,\n don't resize the text to fit and consider wrapping text to a second line.\n- If possible, don't truncate text because it makes it harder to understand what's in the Tab.\n- Try not to use more than six Tabs to keep the UI uncluttered.\n- Do not stack Tabs on top of each other, and do not nest Tabs within Tabs.\n Find alternate ways of navigating page hierarchy.",
|
|
3415
|
+
"attributes": {
|
|
3416
|
+
"size": {
|
|
3417
|
+
"type": "\"sm\"",
|
|
3418
|
+
"description": "Tab sizes\n- **default** displays the cre8-tab text with cre8-typography-label-default\n- **sm** displays the cre8-tab text with cre8-typography-label-small"
|
|
3419
|
+
}
|
|
3420
|
+
},
|
|
3421
|
+
"properties": {
|
|
3422
|
+
"fullWidth": {
|
|
3423
|
+
"type": "boolean",
|
|
3424
|
+
"description": "Displays a set of tabs with a spanning the width of the element"
|
|
3425
|
+
},
|
|
3426
|
+
"activeIndex": {
|
|
3427
|
+
"type": "number",
|
|
3428
|
+
"default": 0,
|
|
3429
|
+
"description": "Sets the initial active tab (e.g. 0 sets the first tab, 1 sets the second tab, etc.)"
|
|
3430
|
+
},
|
|
3431
|
+
"isStart": {
|
|
3432
|
+
"type": "boolean",
|
|
3433
|
+
"default": true,
|
|
3434
|
+
"description": "If position from left is greater than 0, set isStart to false. Otherwise set isStart to true.\n\n_*This property is dynamically set_"
|
|
3435
|
+
},
|
|
3436
|
+
"isEnd": {
|
|
3437
|
+
"type": "boolean",
|
|
3438
|
+
"default": false,
|
|
3439
|
+
"description": "If last child is fully in the viewport, set isEnd to true. Otherwise, set isEnd to false.\n\n_*This property is dynamically set_"
|
|
3440
|
+
},
|
|
3441
|
+
"activeTab": {
|
|
3442
|
+
"type": "Cre8Tab",
|
|
3443
|
+
"description": "The active tab\n\n_*This property is dynamically set_"
|
|
3444
|
+
},
|
|
3445
|
+
"isRTL": {
|
|
3446
|
+
"type": "boolean",
|
|
3447
|
+
"description": "Query the document direction value\n\n_*This property is dynamically set_"
|
|
3448
|
+
},
|
|
3449
|
+
"handleScroll": {
|
|
3450
|
+
"type": "string"
|
|
3451
|
+
},
|
|
3452
|
+
"handleResize": {
|
|
3453
|
+
"type": "string"
|
|
3454
|
+
},
|
|
3455
|
+
"setIsStart": {
|
|
3456
|
+
"type": "string"
|
|
3457
|
+
},
|
|
3458
|
+
"setIsEnd": {
|
|
3459
|
+
"type": "string"
|
|
3460
|
+
},
|
|
3461
|
+
"emitEvent": {
|
|
3462
|
+
"type": "string"
|
|
3463
|
+
},
|
|
3464
|
+
"tabId": {
|
|
3465
|
+
"type": "string",
|
|
3466
|
+
"description": "Auto Increment id to sync tab and tab panel\n\n_*This property is dynamically set_"
|
|
3467
|
+
}
|
|
3468
|
+
},
|
|
3469
|
+
"slots": {
|
|
3470
|
+
"default": {
|
|
3471
|
+
"description": "Default, unnamed slot container for each `cre8-tab` button"
|
|
3472
|
+
},
|
|
3473
|
+
"panel": {
|
|
3474
|
+
"description": "Container for each `cre8-tab-panel` content item"
|
|
3475
|
+
}
|
|
3476
|
+
},
|
|
3477
|
+
"events": {
|
|
3478
|
+
"tabChange": {
|
|
3479
|
+
"detail": {}
|
|
3480
|
+
}
|
|
3481
|
+
},
|
|
3482
|
+
"cssProperties": {},
|
|
3483
|
+
"examples": []
|
|
3484
|
+
},
|
|
3485
|
+
{
|
|
3486
|
+
"name": "cre8-tertiary-nav",
|
|
3487
|
+
"category": "Navigation",
|
|
3488
|
+
"description": "Tertiary Nav component.",
|
|
3489
|
+
"attributes": {},
|
|
3490
|
+
"properties": {
|
|
3491
|
+
"fullWidth": {
|
|
3492
|
+
"type": "boolean",
|
|
3493
|
+
"description": "Allows the tertiary nav to take up the full width of it parent container"
|
|
3494
|
+
},
|
|
3495
|
+
"navAriaLabel": {
|
|
3496
|
+
"type": "string",
|
|
3497
|
+
"default": "tertiary",
|
|
3498
|
+
"description": "aria-label attribute to designate at name for the nav. Can be override by user"
|
|
3499
|
+
}
|
|
3500
|
+
},
|
|
3501
|
+
"slots": {
|
|
3502
|
+
"default": {
|
|
3503
|
+
"description": "The component content"
|
|
3504
|
+
}
|
|
3505
|
+
},
|
|
3506
|
+
"events": {},
|
|
3507
|
+
"cssProperties": {},
|
|
3508
|
+
"examples": []
|
|
3509
|
+
},
|
|
3510
|
+
{
|
|
3511
|
+
"name": "cre8-tertiary-nav-item",
|
|
3512
|
+
"category": "Navigation",
|
|
3513
|
+
"description": "Tertiary Nav Item component.",
|
|
3514
|
+
"attributes": {
|
|
3515
|
+
"href": {
|
|
3516
|
+
"type": "string",
|
|
3517
|
+
"description": "The href value of the tertiary nav link"
|
|
3518
|
+
}
|
|
3519
|
+
},
|
|
3520
|
+
"properties": {
|
|
3521
|
+
"isCurrent": {
|
|
3522
|
+
"type": "boolean",
|
|
3523
|
+
"description": "The current state of the tertiary nav link"
|
|
3524
|
+
}
|
|
3525
|
+
},
|
|
3526
|
+
"slots": {
|
|
3527
|
+
"default": {
|
|
3528
|
+
"description": "The component content"
|
|
3529
|
+
}
|
|
3530
|
+
},
|
|
3531
|
+
"events": {},
|
|
3532
|
+
"cssProperties": {},
|
|
3533
|
+
"examples": []
|
|
3534
|
+
},
|
|
3535
|
+
{
|
|
3536
|
+
"name": "cre8-utility-nav",
|
|
3537
|
+
"category": "Navigation",
|
|
3538
|
+
"description": "Utility Nav component.",
|
|
3539
|
+
"attributes": {
|
|
3540
|
+
"inverted": {
|
|
3541
|
+
"type": "boolean",
|
|
3542
|
+
"description": "Inverted variant\n1) Used for dark backgrounds"
|
|
3543
|
+
}
|
|
3544
|
+
},
|
|
3545
|
+
"properties": {
|
|
3546
|
+
"navAriaLabel": {
|
|
3547
|
+
"type": "string",
|
|
3548
|
+
"default": "utility",
|
|
3549
|
+
"description": "aria-label attribute to designate at name for the nav. Can be override by user"
|
|
3550
|
+
}
|
|
3551
|
+
},
|
|
3552
|
+
"slots": {
|
|
3553
|
+
"default": {
|
|
3554
|
+
"description": "The utility nav items"
|
|
3555
|
+
}
|
|
3556
|
+
},
|
|
3557
|
+
"events": {},
|
|
3558
|
+
"cssProperties": {},
|
|
3559
|
+
"examples": []
|
|
3560
|
+
},
|
|
3561
|
+
{
|
|
3562
|
+
"name": "cre8-utility-nav-item",
|
|
3563
|
+
"category": "Navigation",
|
|
3564
|
+
"description": "Utility Nav Item component.",
|
|
3565
|
+
"attributes": {
|
|
3566
|
+
"href": {
|
|
3567
|
+
"type": "string",
|
|
3568
|
+
"description": "URL of the utility nav item"
|
|
3569
|
+
},
|
|
3570
|
+
"text": {
|
|
3571
|
+
"type": "string",
|
|
3572
|
+
"description": "Text of the utility nav item"
|
|
3573
|
+
}
|
|
3574
|
+
},
|
|
3575
|
+
"properties": {
|
|
3576
|
+
"hideText": {
|
|
3577
|
+
"type": "boolean",
|
|
3578
|
+
"description": "Hide text toggle\n1) Visually hides the text so screenreaders can still read for accessibility when set to true."
|
|
3579
|
+
},
|
|
3580
|
+
"iconName": {
|
|
3581
|
+
"type": "string",
|
|
3582
|
+
"description": "Icon name"
|
|
3583
|
+
},
|
|
3584
|
+
"iconPosition": {
|
|
3585
|
+
"type": "string",
|
|
3586
|
+
"values": [
|
|
3587
|
+
"before",
|
|
3588
|
+
"after"
|
|
3589
|
+
],
|
|
3590
|
+
"default": "undefined",
|
|
3591
|
+
"description": "Icon position\n<cre8-text-passage size=\"sm\">\n<ul>\n<li>**before** places the icon before the text</li>\n<li>**after** places the icon after the text</li>\n</ul>\n</cre8-text-passage>"
|
|
3592
|
+
}
|
|
3593
|
+
},
|
|
3594
|
+
"slots": {},
|
|
3595
|
+
"events": {},
|
|
3596
|
+
"cssProperties": {},
|
|
3597
|
+
"examples": [
|
|
3598
|
+
{
|
|
3599
|
+
"description": "Basic utility-nav-item",
|
|
3600
|
+
"html": "<cre8-utility-nav-item text=\"Utility Nav Item\"></cre8-utility-nav-item>"
|
|
3601
|
+
}
|
|
3602
|
+
]
|
|
3603
|
+
},
|
|
3604
|
+
{
|
|
3605
|
+
"name": "cre8-heading",
|
|
3606
|
+
"category": "Typography",
|
|
3607
|
+
"description": "HTML headings are titles or subtitles that you want to display on a webpage. The H1 is the most important and H6\nis the least important in the content hierarchy.\n\n# How to Use\n1. The cre8-heading tag wraps around one of the six native HTML \"h\" tags, depending on your chosen variation.\n2. There are two main use cases for using this component:\n text passage headings and Components with a title (i.e. modal, card or alert)\n3. There will be instances when the design requires the heading text to have the brand color applied\n in which case you should set the [brandColor](?path=/story/cre8-components-heading--brand-color)\n attribute to true on the cre8-heading tag.\n4. For dark backgrounds, add the [inverted](?path=/story/cre8-components-heading--inverted)\n attribute to the tag for white text.",
|
|
3608
|
+
"attributes": {
|
|
3609
|
+
"type": {
|
|
3610
|
+
"type": "\"display-default\" | \"display-small\" | \"headline-large\" | \"headline-default\" | \"headline-small\" | \"title-xlarge\" | \"title-large\" | \"title-default\" | \"title-small\" | \"label-large\" | ... 5 more ...",
|
|
3611
|
+
"description": "Heading type\n<cre8-text-passage size=\"small\">\n<ul>\n<li>**display-default** renders a heading with the heading display-default preset treatment</li>\n<li>**display-small** renders a heading with the heading display-small preset treatment</li>\n<li>**headline-large** renders a heading with the heading headline-large preset treatment</li>\n<li>**headline-default** renders a heading with the heading headline-default preset treatment</li>\n<li>**headline-small** renders a heading with the heading headline-small preset treatment</li>\n<li>**title-xlarge** renders a heading with the heading title-xlarge preset treatment</li>\n<li>**title-large** renders a heading with the heading title-large preset treatment</li>\n<li>**title-default** renders a heading with the heading title-default preset treatment</li>\n<li>**title-small** renders a heading with the heading title-small preset treatment</li>\n<li>**label-large** renders a heading with the label-large preset treatment</li>\n<li>**label** renders a heading with the label preset treatment</li>\n<li>**label-small** renders a heading with the label-small preset treatment</li>\n<li>**meta-large** renders a heading with the meta-large preset treatment</li>\n<li>**meta-default** renders a heading with the meta-default preset treatment</li>\n<li>**meta-small** renders a heading with the meta-small preset treatment</li>\n</ul>\n</cre8-text-passage>"
|
|
3612
|
+
},
|
|
3613
|
+
"inverted": {
|
|
3614
|
+
"type": "boolean",
|
|
3615
|
+
"description": "Invert the color of the font from dark to light. An inverted `heading` should be used on a dark background."
|
|
3616
|
+
}
|
|
3617
|
+
},
|
|
3618
|
+
"properties": {
|
|
3619
|
+
"tagVariant": {
|
|
3620
|
+
"type": "string",
|
|
3621
|
+
"default": "h5",
|
|
3622
|
+
"description": "Dynamic tag name for the component\n1) This is needed to use proper semantic heading treatments depending on where the banner lives on the page\n<cre8-text-passage size=\"small\">\n<ul>\n<li>**h1** renders an `h1` tag</li>\n<li>**h2** renders an `h2` tag. This is the default</li>\n<li>**h3** renders an `h3` tag</li>\n<li>**h4** renders an `h4` tag</li>\n<li>**h5** renders an `h5` tag</li>\n<li>**h6** renders an `h6` tag</li>\n</ul>\n</cre8-text-passage>"
|
|
3623
|
+
},
|
|
3624
|
+
"brandColor": {
|
|
3625
|
+
"type": "boolean",
|
|
3626
|
+
"description": "Apply the brand color to the heading text."
|
|
3627
|
+
}
|
|
3628
|
+
},
|
|
3629
|
+
"slots": {
|
|
3630
|
+
"default": {
|
|
3631
|
+
"description": "The heading text content"
|
|
3632
|
+
}
|
|
3633
|
+
},
|
|
3634
|
+
"events": {},
|
|
3635
|
+
"cssProperties": {},
|
|
3636
|
+
"examples": []
|
|
3637
|
+
},
|
|
3638
|
+
{
|
|
3639
|
+
"name": "cre8-text-link",
|
|
3640
|
+
"category": "Typography",
|
|
3641
|
+
"description": "Text Link component.",
|
|
3642
|
+
"attributes": {
|
|
3643
|
+
"href": {
|
|
3644
|
+
"type": "string",
|
|
3645
|
+
"description": "The link URL"
|
|
3646
|
+
},
|
|
3647
|
+
"variant": {
|
|
3648
|
+
"type": "string",
|
|
3649
|
+
"values": [
|
|
3650
|
+
"secondary",
|
|
3651
|
+
"display"
|
|
3652
|
+
],
|
|
3653
|
+
"description": "Style variant\n<cre8-text-passage size=\"sm\">\n<ul>\n<li> **display** applies display treatment to the text link (e.g. article title link)</li>\n<li> **secondary** applies secondary treatment to the text link (e.g. non-prominent links)</li>\n</ul>\n</cre8-text-passage>"
|
|
3654
|
+
},
|
|
3655
|
+
"size": {
|
|
3656
|
+
"type": "\"sm\"",
|
|
3657
|
+
"description": "Size variant\n<cre8-text-passage size=\"sm\">\n<ul>\n<li> **sm** renders a smaller typography preset than the default</li>\n</ul>\n</cre8-text-passage>"
|
|
3658
|
+
},
|
|
3659
|
+
"inverted": {
|
|
3660
|
+
"type": "boolean",
|
|
3661
|
+
"description": "Inverted variant\n1) Used for dark backgrounds"
|
|
3662
|
+
}
|
|
3663
|
+
},
|
|
3664
|
+
"properties": {},
|
|
3665
|
+
"slots": {
|
|
3666
|
+
"default": {
|
|
3667
|
+
"description": "The component content"
|
|
3668
|
+
}
|
|
3669
|
+
},
|
|
3670
|
+
"events": {},
|
|
3671
|
+
"cssProperties": {},
|
|
3672
|
+
"examples": [
|
|
3673
|
+
{
|
|
3674
|
+
"description": "Secondary text-link",
|
|
3675
|
+
"html": "<cre8-text-link variant=\"secondary\"></cre8-text-link>"
|
|
3676
|
+
}
|
|
3677
|
+
]
|
|
3678
|
+
},
|
|
3679
|
+
{
|
|
3680
|
+
"name": "cre8-text-passage",
|
|
3681
|
+
"category": "Typography",
|
|
3682
|
+
"description": "The text-passage component acts a general wrapper element\nfor any text content that needs to be used in your project.\n\n# How to Use\n1. Code your text passage using any of the native html text elements (p, ol, ul, blockquote, cite, etc.)\n or other Cre8 Components like cre8-heading and wrap them with the cre8-text-passage tags.\n2. Choose between three sizes for your text content or apply inline styling if you need additional styling.\n3. For dark backgrounds, add the 'inverted' attribute to the <cre8-text-passage> tag.\n3. Your text-passage will render with brand-approved styling!\n\n\nNOTE: It is recommended that you use the cre8-heading component for any heading elements in your HTML template",
|
|
3683
|
+
"attributes": {
|
|
3684
|
+
"inverted": {
|
|
3685
|
+
"type": "boolean",
|
|
3686
|
+
"description": "Inverted variant\n1) Used for dark backgrounds"
|
|
3687
|
+
},
|
|
3688
|
+
"size": {
|
|
3689
|
+
"type": "string",
|
|
3690
|
+
"values": [
|
|
3691
|
+
"large",
|
|
3692
|
+
"small",
|
|
3693
|
+
"default"
|
|
3694
|
+
],
|
|
3695
|
+
"default": "default",
|
|
3696
|
+
"description": "Size variant\n- **small** renders smaller typography than the default variant\n- **default** renders default typography variant\n- **large** renders larger typography than the default variant"
|
|
3697
|
+
}
|
|
3698
|
+
},
|
|
3699
|
+
"properties": {},
|
|
3700
|
+
"slots": {
|
|
3701
|
+
"default": {
|
|
3702
|
+
"description": "The component content"
|
|
3703
|
+
}
|
|
3704
|
+
},
|
|
3705
|
+
"events": {},
|
|
3706
|
+
"cssProperties": {},
|
|
3707
|
+
"examples": []
|
|
3708
|
+
}
|
|
3709
|
+
],
|
|
3710
|
+
"baseClasses": [
|
|
3711
|
+
{
|
|
3712
|
+
"name": "Cre8Element",
|
|
3713
|
+
"description": "Base class extending LitElement with utility methods.",
|
|
3714
|
+
"methods": {
|
|
3715
|
+
"componentClassNames": {
|
|
3716
|
+
"signature": "(baseClassName, additionalClassNames) => string",
|
|
3717
|
+
"description": "Helper for applying class names with variants"
|
|
3718
|
+
},
|
|
3719
|
+
"slotEmpty": {
|
|
3720
|
+
"signature": "(slotName: string) => boolean",
|
|
3721
|
+
"description": "Check if a named slot has content"
|
|
3722
|
+
},
|
|
3723
|
+
"slotNotEmpty": {
|
|
3724
|
+
"signature": "(slotName: string) => boolean",
|
|
3725
|
+
"description": "Inverse check for slot content"
|
|
3726
|
+
},
|
|
3727
|
+
"dispatch": {
|
|
3728
|
+
"signature": "({ e, eventName, detailObj, optionsObj }) => void",
|
|
3729
|
+
"description": "Custom event dispatcher"
|
|
3730
|
+
}
|
|
3731
|
+
}
|
|
3732
|
+
},
|
|
3733
|
+
{
|
|
3734
|
+
"name": "Cre8FormElement",
|
|
3735
|
+
"description": "Base class for form-associated custom elements. Extends Cre8Element.",
|
|
3736
|
+
"attributes": {
|
|
3737
|
+
"name": {
|
|
3738
|
+
"type": "string",
|
|
3739
|
+
"description": "Form field name"
|
|
3740
|
+
},
|
|
3741
|
+
"disabled": {
|
|
3742
|
+
"type": "boolean",
|
|
3743
|
+
"description": "Disabled state"
|
|
3744
|
+
},
|
|
3745
|
+
"required": {
|
|
3746
|
+
"type": "boolean",
|
|
3747
|
+
"description": "Required state"
|
|
3748
|
+
},
|
|
3749
|
+
"is-error": {
|
|
3750
|
+
"type": "boolean",
|
|
3751
|
+
"description": "Error state indicator"
|
|
3752
|
+
},
|
|
3753
|
+
"is-success": {
|
|
3754
|
+
"type": "boolean",
|
|
3755
|
+
"description": "Success state indicator"
|
|
3756
|
+
}
|
|
3757
|
+
},
|
|
3758
|
+
"properties": {
|
|
3759
|
+
"value": {
|
|
3760
|
+
"type": "any",
|
|
3761
|
+
"description": "Form field value with getter/setter"
|
|
3762
|
+
}
|
|
3763
|
+
},
|
|
3764
|
+
"formInternals": {
|
|
3765
|
+
"description": "Uses ElementInternals API (attachInternals())",
|
|
3766
|
+
"lifecycleCallbacks": [
|
|
3767
|
+
"formResetCallback()",
|
|
3768
|
+
"formDisabledCallback()",
|
|
3769
|
+
"formStateRestoreCallback()"
|
|
3770
|
+
],
|
|
3771
|
+
"methods": [
|
|
3772
|
+
"checkValidity()",
|
|
3773
|
+
"reportValidity()",
|
|
3774
|
+
"setCustomValidity(message)"
|
|
3775
|
+
]
|
|
3776
|
+
}
|
|
3777
|
+
}
|
|
3778
|
+
],
|
|
3779
|
+
"patterns": [
|
|
3780
|
+
{
|
|
3781
|
+
"name": "Login Form",
|
|
3782
|
+
"description": "Standard login form with email and password",
|
|
3783
|
+
"template": "<cre8-card>\n <cre8-heading tag-variant=\"h2\" type=\"headline-default\">Sign In</cre8-heading>\n <cre8-field label=\"Email\" type=\"email\"></cre8-field>\n <cre8-field label=\"Password\" type=\"password\"></cre8-field>\n <cre8-button text=\"Sign In\" variant=\"primary\" full-width></cre8-button>\n</cre8-card>"
|
|
3784
|
+
},
|
|
3785
|
+
{
|
|
3786
|
+
"name": "Data Table",
|
|
3787
|
+
"description": "Table with header and data rows",
|
|
3788
|
+
"template": "<cre8-table variant=\"striped\" is-hoverable>\n <cre8-table-header>\n <cre8-table-row>\n <cre8-table-header-cell>Name</cre8-table-header-cell>\n <cre8-table-header-cell>Status</cre8-table-header-cell>\n </cre8-table-row>\n </cre8-table-header>\n <cre8-table-body>\n <cre8-table-row>\n <cre8-table-cell>Item 1</cre8-table-cell>\n <cre8-table-cell><cre8-badge text=\"Active\" status=\"success\"></cre8-badge></cre8-table-cell>\n </cre8-table-row>\n </cre8-table-body>\n</cre8-table>"
|
|
3789
|
+
},
|
|
3790
|
+
{
|
|
3791
|
+
"name": "Page Layout",
|
|
3792
|
+
"description": "Standard page with header, main content, and footer",
|
|
3793
|
+
"template": "<cre8-layout>\n <cre8-header>\n <cre8-global-nav>\n <span slot=\"logo\"><cre8-logo></cre8-logo></span>\n <cre8-global-nav-item href=\"/\">Home</cre8-global-nav-item>\n </cre8-global-nav>\n </cre8-header>\n <cre8-main>\n <cre8-layout-container>\n <!-- Page content -->\n </cre8-layout-container>\n </cre8-main>\n <cre8-footer>\n <span slot=\"copyright\">2024 Company Name</span>\n </cre8-footer>\n</cre8-layout>"
|
|
3794
|
+
},
|
|
3795
|
+
{
|
|
3796
|
+
"name": "Alert Banner",
|
|
3797
|
+
"description": "Dismissible alert at top of page",
|
|
3798
|
+
"template": "<cre8-alert status=\"info\" variant=\"banner\">\n Important announcement message here.\n</cre8-alert>"
|
|
3799
|
+
},
|
|
3800
|
+
{
|
|
3801
|
+
"name": "Tabbed Content",
|
|
3802
|
+
"description": "Content organized in tabs",
|
|
3803
|
+
"template": "<cre8-tabs>\n <cre8-tab label=\"Tab 1\" tab-id=\"tab1\" selected></cre8-tab>\n <cre8-tab label=\"Tab 2\" tab-id=\"tab2\"></cre8-tab>\n <cre8-tab-panel tab-id=\"tab1\" slot=\"panel\">Content for Tab 1</cre8-tab-panel>\n <cre8-tab-panel tab-id=\"tab2\" slot=\"panel\">Content for Tab 2</cre8-tab-panel>\n</cre8-tabs>"
|
|
3804
|
+
},
|
|
3805
|
+
{
|
|
3806
|
+
"name": "Modal Dialog",
|
|
3807
|
+
"description": "Modal with header, body, and footer actions",
|
|
3808
|
+
"template": "<cre8-modal is-active aria-label=\"Confirmation\">\n <span slot=\"header\">Confirm Action</span>\n <p>Are you sure you want to proceed?</p>\n <div slot=\"footer\">\n <cre8-button text=\"Cancel\" variant=\"secondary\"></cre8-button>\n <cre8-button text=\"Confirm\" variant=\"primary\"></cre8-button>\n </div>\n</cre8-modal>"
|
|
3809
|
+
}
|
|
3810
|
+
],
|
|
3811
|
+
"designTokens": {
|
|
3812
|
+
"description": "Design tokens are provided by the @tmorrow/cre8-design-tokens package",
|
|
3813
|
+
"tokenPackage": "@tmorrow/cre8-design-tokens",
|
|
3814
|
+
"categories": [
|
|
3815
|
+
"colors",
|
|
3816
|
+
"typography",
|
|
3817
|
+
"spacing",
|
|
3818
|
+
"borders",
|
|
3819
|
+
"shadows",
|
|
3820
|
+
"breakpoints"
|
|
3821
|
+
]
|
|
3822
|
+
},
|
|
3823
|
+
"accessibility": {
|
|
3824
|
+
"features": [
|
|
3825
|
+
"ARIA attributes (aria-label, aria-describedby, aria-live, aria-expanded)",
|
|
3826
|
+
"Semantic HTML elements",
|
|
3827
|
+
"Focus management with @a11y/focus-trap",
|
|
3828
|
+
"Keyboard navigation (Escape, Tab, Arrow keys, Enter, Space)",
|
|
3829
|
+
"Screen reader support",
|
|
3830
|
+
"Form validation and error messaging"
|
|
3831
|
+
]
|
|
3832
|
+
},
|
|
3833
|
+
"dependencies": {
|
|
3834
|
+
"lit": "3.3.1",
|
|
3835
|
+
"@lit/context": "^1.1.6",
|
|
3836
|
+
"@lit/react": "^1.0.8",
|
|
3837
|
+
"@a11y/focus-trap": "^1.0.5",
|
|
3838
|
+
"chart.js": "^4.5.1",
|
|
3839
|
+
"classnames": "2.5.1",
|
|
3840
|
+
"nanoid": "^5.1.6",
|
|
3841
|
+
"zod": "^4.1.12",
|
|
3842
|
+
"@tmorrow/cre8-design-tokens": "^1.0.16"
|
|
3843
|
+
}
|
|
3844
|
+
}
|