@appquality/unguess-design-system 2.8.6 → 2.8.12

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.
Files changed (208) hide show
  1. package/.github/workflows/release.yml +43 -0
  2. package/.github/workflows/storybook.yml +37 -37
  3. package/.prettierrc +3 -3
  4. package/CHANGELOG.md +661 -584
  5. package/README.md +73 -73
  6. package/build/hooks/useWindowSize.d.ts +4 -0
  7. package/build/index.d.ts +63 -0
  8. package/build/index.js +2155 -0
  9. package/build/stories/accordions/_types.d.ts +25 -0
  10. package/build/stories/accordions/index.d.ts +17 -0
  11. package/build/stories/accordions/index.stories.d.ts +21 -0
  12. package/build/stories/avatar/_types.d.ts +19 -0
  13. package/build/stories/avatar/index.d.ts +13 -0
  14. package/build/stories/avatar/index.stories.d.ts +10 -0
  15. package/build/stories/breadcrumbs/_types.d.ts +5 -0
  16. package/build/stories/breadcrumbs/index.d.ts +11 -0
  17. package/build/stories/breadcrumbs/index.stories.d.ts +6 -0
  18. package/build/stories/buttons/anchor/_types.d.ts +11 -0
  19. package/build/stories/buttons/anchor/index.d.ts +12 -0
  20. package/build/stories/buttons/anchor/index.stories.d.ts +8 -0
  21. package/build/stories/buttons/button/_types.d.ts +30 -0
  22. package/build/stories/buttons/button/index.d.ts +22 -0
  23. package/build/stories/buttons/button/index.stories.d.ts +19 -0
  24. package/build/stories/buttons/button-group/_types.d.ts +5 -0
  25. package/build/stories/buttons/button-group/index.d.ts +9 -0
  26. package/build/stories/buttons/button-group/index.stories.d.ts +15 -0
  27. package/build/stories/buttons/icon-button/_types.d.ts +19 -0
  28. package/build/stories/buttons/icon-button/index.d.ts +14 -0
  29. package/build/stories/buttons/icon-button/index.stories.d.ts +9 -0
  30. package/build/stories/buttons/shared/_shared.d.ts +2 -0
  31. package/build/stories/buttons/split-button/_types.d.ts +2 -0
  32. package/build/stories/buttons/split-button/index.d.ts +11 -0
  33. package/build/stories/buttons/split-button/index.stories.d.ts +6 -0
  34. package/build/stories/buttons/utils/useButtonVariant.d.ts +5 -0
  35. package/build/stories/campaignCards/_types.d.ts +43 -0
  36. package/build/stories/campaignCards/index.d.ts +4 -0
  37. package/build/stories/campaignCards/index.stories.d.ts +7 -0
  38. package/build/stories/cards/_types.d.ts +7 -0
  39. package/build/stories/cards/index.d.ts +10 -0
  40. package/build/stories/cards/index.stories.d.ts +11 -0
  41. package/build/stories/close/_types.d.ts +3 -0
  42. package/build/stories/close/index.d.ts +7 -0
  43. package/build/stories/close/index.stories.d.ts +6 -0
  44. package/build/stories/counter/_types.d.ts +5 -0
  45. package/build/stories/counter/index.d.ts +13 -0
  46. package/build/stories/counter/index.stories.d.ts +15 -0
  47. package/build/stories/dropdowns/field/_types.d.ts +2 -0
  48. package/build/stories/dropdowns/field/index.d.ts +3 -0
  49. package/build/stories/dropdowns/item/_types.d.ts +9 -0
  50. package/build/stories/dropdowns/item/index.d.ts +4 -0
  51. package/build/stories/dropdowns/menu/_types.d.ts +47 -0
  52. package/build/stories/dropdowns/menu/index.d.ts +14 -0
  53. package/build/stories/dropdowns/menu/index.stories.d.ts +6 -0
  54. package/build/stories/dropdowns/multiselect/_types.d.ts +17 -0
  55. package/build/stories/dropdowns/multiselect/index.d.ts +11 -0
  56. package/build/stories/dropdowns/multiselect/index.stories.d.ts +21 -0
  57. package/build/stories/dropdowns/select/_types.d.ts +33 -0
  58. package/build/stories/dropdowns/select/index.d.ts +16 -0
  59. package/build/stories/dropdowns/select/index.stories.d.ts +20 -0
  60. package/build/stories/forms/checkbox/_types.d.ts +8 -0
  61. package/build/stories/forms/checkbox/index.d.ts +14 -0
  62. package/build/stories/forms/checkbox/index.stories.d.ts +6 -0
  63. package/build/stories/forms/field/_types.d.ts +3 -0
  64. package/build/stories/forms/field/index.d.ts +8 -0
  65. package/build/stories/forms/field/index.stories.d.ts +6 -0
  66. package/build/stories/forms/input/_types.d.ts +9 -0
  67. package/build/stories/forms/input/index.d.ts +11 -0
  68. package/build/stories/forms/input/index.stories.d.ts +9 -0
  69. package/build/stories/forms/radio/_types.d.ts +3 -0
  70. package/build/stories/forms/radio/index.d.ts +14 -0
  71. package/build/stories/forms/radio/index.stories.d.ts +7 -0
  72. package/build/stories/forms/textarea/_types.d.ts +15 -0
  73. package/build/stories/forms/textarea/index.d.ts +10 -0
  74. package/build/stories/forms/textarea/index.stories.d.ts +8 -0
  75. package/build/stories/forms/toggle/_types.d.ts +3 -0
  76. package/build/stories/forms/toggle/index.d.ts +13 -0
  77. package/build/stories/forms/toggle/index.stories.d.ts +10 -0
  78. package/build/stories/grid/col/_types.d.ts +77 -0
  79. package/build/stories/grid/col/index.d.ts +4 -0
  80. package/build/stories/grid/col/index.stories.d.ts +8 -0
  81. package/build/stories/grid/grid/_types.d.ts +9 -0
  82. package/build/stories/grid/grid/index.d.ts +10 -0
  83. package/build/stories/grid/grid/index.stories.d.ts +12 -0
  84. package/build/stories/grid/row/_types.d.ts +48 -0
  85. package/build/stories/grid/row/index.d.ts +4 -0
  86. package/build/stories/grid/row/index.stories.d.ts +10 -0
  87. package/build/stories/icons/_types.d.ts +7 -0
  88. package/build/stories/icons/index.d.ts +4 -0
  89. package/build/stories/icons/index.stories.d.ts +6 -0
  90. package/build/stories/label/_types.d.ts +5 -0
  91. package/build/stories/label/index.d.ts +8 -0
  92. package/build/stories/label/index.stories.d.ts +7 -0
  93. package/build/stories/loaders/progress/_types.d.ts +12 -0
  94. package/build/stories/loaders/progress/index.d.ts +14 -0
  95. package/build/stories/loaders/progress/index.stories.d.ts +6 -0
  96. package/build/stories/loaders/skeleton/_types.d.ts +9 -0
  97. package/build/stories/loaders/skeleton/index.d.ts +17 -0
  98. package/build/stories/loaders/skeleton/index.stories.d.ts +7 -0
  99. package/build/stories/loaders/spinner/_types.d.ts +19 -0
  100. package/build/stories/loaders/spinner/index.d.ts +11 -0
  101. package/build/stories/loaders/spinner/index.stories.d.ts +6 -0
  102. package/build/stories/login-form/_types.d.ts +29 -0
  103. package/build/stories/login-form/index.d.ts +10 -0
  104. package/build/stories/login-form/index.stories.d.ts +7 -0
  105. package/build/stories/logo/_types.d.ts +9 -0
  106. package/build/stories/logo/index.d.ts +13 -0
  107. package/build/stories/logo/index.stories.d.ts +6 -0
  108. package/build/stories/modals/_types.d.ts +34 -0
  109. package/build/stories/modals/index.d.ts +11 -0
  110. package/build/stories/modals/index.stories.d.ts +19 -0
  111. package/build/stories/navigation/app-header/_types.d.ts +18 -0
  112. package/build/stories/navigation/app-header/index.d.ts +8 -0
  113. package/build/stories/navigation/app-header/index.stories.d.ts +6 -0
  114. package/build/stories/navigation/body/_types.d.ts +5 -0
  115. package/build/stories/navigation/body/index.d.ts +7 -0
  116. package/build/stories/navigation/chrome/_types.d.ts +7 -0
  117. package/build/stories/navigation/chrome/index.d.ts +10 -0
  118. package/build/stories/navigation/content/_types.d.ts +2 -0
  119. package/build/stories/navigation/content/index.d.ts +7 -0
  120. package/build/stories/navigation/header/_types.d.ts +5 -0
  121. package/build/stories/navigation/header/header-item/_types.d.ts +32 -0
  122. package/build/stories/navigation/header/header-item/brandItem.d.ts +4 -0
  123. package/build/stories/navigation/header/header-item/headerItem.d.ts +4 -0
  124. package/build/stories/navigation/header/header-item/headerItemIcon.d.ts +4 -0
  125. package/build/stories/navigation/header/header-item/headerItemText.d.ts +4 -0
  126. package/build/stories/navigation/header/header-item/index.d.ts +5 -0
  127. package/build/stories/navigation/header/header-item/utils.d.ts +13 -0
  128. package/build/stories/navigation/header/index.d.ts +13 -0
  129. package/build/stories/navigation/main/_types.d.ts +2 -0
  130. package/build/stories/navigation/main/index.d.ts +7 -0
  131. package/build/stories/navigation/nav/_types.d.ts +5 -0
  132. package/build/stories/navigation/nav/index.d.ts +10 -0
  133. package/build/stories/navigation/nav/nav-item/_types.d.ts +29 -0
  134. package/build/stories/navigation/nav/nav-item/index.d.ts +7 -0
  135. package/build/stories/navigation/nav/nav-item/navDivider.d.ts +4 -0
  136. package/build/stories/navigation/nav/nav-item/navItem.d.ts +4 -0
  137. package/build/stories/navigation/nav/nav-item/navItemIcon.d.ts +4 -0
  138. package/build/stories/navigation/nav/nav-item/navItemProject.d.ts +8 -0
  139. package/build/stories/navigation/nav/nav-item/navItemText.d.ts +4 -0
  140. package/build/stories/navigation/nav/nav-item/navToggle.d.ts +4 -0
  141. package/build/stories/navigation/sidebar/_types.d.ts +17 -0
  142. package/build/stories/navigation/sidebar/index.d.ts +10 -0
  143. package/build/stories/navigation/sidebar/index.stories.d.ts +9 -0
  144. package/build/stories/notifications/_types.d.ts +9 -0
  145. package/build/stories/notifications/index.d.ts +20 -0
  146. package/build/stories/notifications/index.stories.d.ts +10 -0
  147. package/build/stories/page/index.d.ts +8 -0
  148. package/build/stories/page/index.stories.d.ts +6 -0
  149. package/build/stories/pagination/_types.d.ts +34 -0
  150. package/build/stories/pagination/index.d.ts +17 -0
  151. package/build/stories/pagination/index.stories.d.ts +7 -0
  152. package/build/stories/profile-modal/UserContainer.d.ts +3 -0
  153. package/build/stories/profile-modal/_types.d.ts +43 -0
  154. package/build/stories/profile-modal/helpMenuItem.d.ts +18 -0
  155. package/build/stories/profile-modal/index.d.ts +11 -0
  156. package/build/stories/profile-modal/index.stories.d.ts +6 -0
  157. package/build/stories/profile-modal/languageMenuItem.d.ts +14 -0
  158. package/build/stories/profile-modal/menuItem.d.ts +11 -0
  159. package/build/stories/profile-modal/menuItemIcon.d.ts +9 -0
  160. package/build/stories/profile-modal/previousMenuButton.d.ts +3 -0
  161. package/build/stories/profile-modal/userMenu.d.ts +3 -0
  162. package/build/stories/profile-modal/utils.d.ts +1 -0
  163. package/build/stories/shared/globalStyle.d.ts +2 -0
  164. package/build/stories/table/_types.d.ts +83 -0
  165. package/build/stories/table/grouped.d.ts +5 -0
  166. package/build/stories/table/index.d.ts +21 -0
  167. package/build/stories/table/index.stories.d.ts +18 -0
  168. package/build/stories/tags/_types.d.ts +17 -0
  169. package/build/stories/tags/index.d.ts +22 -0
  170. package/build/stories/tags/index.stories.d.ts +19 -0
  171. package/build/stories/theme/gradients.d.ts +4 -0
  172. package/build/stories/theme/index.d.ts +244 -0
  173. package/build/stories/theme/mixins.d.ts +3 -0
  174. package/build/stories/theme/palette.d.ts +141 -0
  175. package/build/stories/theme/palette.stories.d.ts +15 -0
  176. package/build/stories/theme/utils.d.ts +3 -0
  177. package/build/stories/tiles/_types.d.ts +12 -0
  178. package/build/stories/tiles/index.d.ts +22 -0
  179. package/build/stories/tiles/index.stories.d.ts +25 -0
  180. package/build/stories/title/_types.d.ts +5 -0
  181. package/build/stories/title/index.d.ts +7 -0
  182. package/build/stories/title/index.stories.d.ts +6 -0
  183. package/build/stories/trigger/_types.d.ts +3 -0
  184. package/build/stories/trigger/index.d.ts +7 -0
  185. package/build/stories/typography/block-quote/_types.d.ts +5 -0
  186. package/build/stories/typography/block-quote/index.d.ts +7 -0
  187. package/build/stories/typography/block-quote/index.stories.d.ts +5 -0
  188. package/build/stories/typography/code/_types.d.ts +7 -0
  189. package/build/stories/typography/code/index.d.ts +7 -0
  190. package/build/stories/typography/code/index.stories.d.ts +8 -0
  191. package/build/stories/typography/ellipsis/_types.d.ts +9 -0
  192. package/build/stories/typography/ellipsis/index.d.ts +7 -0
  193. package/build/stories/typography/ellipsis/index.stories.d.ts +5 -0
  194. package/build/stories/typography/lists/_types.d.ts +17 -0
  195. package/build/stories/typography/lists/index.d.ts +16 -0
  196. package/build/stories/typography/lists/ordered.stories.d.ts +9 -0
  197. package/build/stories/typography/lists/unordered.stories.d.ts +9 -0
  198. package/build/stories/typography/paragraph/_types.d.ts +5 -0
  199. package/build/stories/typography/paragraph/index.d.ts +7 -0
  200. package/build/stories/typography/paragraph/index.stories.d.ts +6 -0
  201. package/build/stories/typography/span/_types.d.ts +13 -0
  202. package/build/stories/typography/span/index.d.ts +13 -0
  203. package/build/stories/typography/span/index.stories.d.ts +6 -0
  204. package/build/stories/typography/typescale/_types.d.ts +43 -0
  205. package/build/stories/typography/typescale/index.d.ts +12 -0
  206. package/build/stories/typography/typescale/index.stories.d.ts +5 -0
  207. package/generate-story.sh +60 -60
  208. package/package.json +119 -119
@@ -0,0 +1,11 @@
1
+ /// <reference types="react" />
2
+ import { MultiselectArgs } from "./_types";
3
+ /**
4
+ * Multiselect lets users select multiple items from a list. Options are dynamically filtered as a user types in the input field and their selections appear as tags in the input field.
5
+ * <hr>
6
+ * Used for this:
7
+ - To choose multiple items from a list of options
8
+ - To filter through a set of data by typing
9
+ */
10
+ declare const Multiselect: (props: MultiselectArgs) => JSX.Element;
11
+ export { Multiselect };
@@ -0,0 +1,21 @@
1
+ /// <reference types="react" />
2
+ import { ComponentMeta, Story } from "@storybook/react";
3
+ import { MultiselectArgs } from "./_types";
4
+ import { MenuArgs } from "../menu/_types";
5
+ import { DropdownArgs } from "../select/_types";
6
+ interface IItem {
7
+ label: string;
8
+ value: string;
9
+ }
10
+ interface MenuStoryArgs {
11
+ dropdown: DropdownArgs;
12
+ menu: MenuArgs;
13
+ items: Array<IItem>;
14
+ select: MultiselectArgs;
15
+ validation?: "success" | "warning" | "error";
16
+ hasHelpText?: boolean;
17
+ }
18
+ export declare const Default: Story<MenuStoryArgs>;
19
+ export declare const Validation: Story<MenuStoryArgs>;
20
+ declare const _default: ComponentMeta<(props: MultiselectArgs) => JSX.Element>;
21
+ export default _default;
@@ -0,0 +1,33 @@
1
+ import { IDropdownProps, ISelectProps, IMessageProps } from "@zendeskgarden/react-dropdowns";
2
+ export interface DropdownArgs extends IDropdownProps {
3
+ /** Opens the dropdown */
4
+ isOpen?: boolean;
5
+ /** Identifies the currently selected item */
6
+ selectedItem?: any;
7
+ /** Identifies the currently selected items */
8
+ selectedItems?: any[];
9
+ /** Highlights an element at a selected index */
10
+ highlightedIndex?: number;
11
+ /** Sets the value of the input element*/
12
+ inputValue?: string;
13
+ }
14
+ export interface SelectArgs extends ISelectProps {
15
+ /** Applies compact styling */
16
+ isCompact?: boolean;
17
+ /** Removes borders and padding */
18
+ isBare?: boolean;
19
+ /** Indicates that the element is not interactive */
20
+ disabled?: boolean;
21
+ /** Applies inset `box-shadow` styling on focus */
22
+ focusInset?: boolean;
23
+ /** Defines the element's validation state */
24
+ validation?: 'success' | 'warning' | 'error';
25
+ /** Defines the icon rendered before the element's content */
26
+ start?: any;
27
+ /** Sets the style of dropdown item*/
28
+ isPrimary?: boolean;
29
+ }
30
+ export interface MessageArgs extends IMessageProps {
31
+ /** Applies styles based on validation state */
32
+ validation?: 'success' | 'warning' | 'error';
33
+ }
@@ -0,0 +1,16 @@
1
+ import { PropsWithChildren } from "react";
2
+ import { SelectArgs, DropdownArgs, MessageArgs } from "./_types";
3
+ /**
4
+ * Select allows a user to pick one option from a list. This helps simplify the UI when space is limited
5
+ * <hr>
6
+ * Used for this:
7
+ - To make a selection from a list of options
8
+ * Not for this:
9
+ - To filter a large list of options, use Autocomplete instead
10
+ - To make multiple selections from a list, use Multiselect instead
11
+ - To select from a list on mobile, use a native Select instead
12
+ */
13
+ declare const Select: (props: SelectArgs) => JSX.Element;
14
+ declare const Dropdown: (props: PropsWithChildren<DropdownArgs>) => JSX.Element;
15
+ declare const Message: (props: MessageArgs) => JSX.Element;
16
+ export { Select, Dropdown, Message };
@@ -0,0 +1,20 @@
1
+ /// <reference types="react" />
2
+ import { ComponentMeta, Story } from "@storybook/react";
3
+ import { DropdownArgs, SelectArgs } from "./_types";
4
+ import { MenuArgs } from "../menu/_types";
5
+ interface IItem {
6
+ label: string;
7
+ value: string;
8
+ }
9
+ interface MenuStoryArgs {
10
+ dropdown: DropdownArgs;
11
+ menu: MenuArgs;
12
+ items: Array<IItem>;
13
+ select: SelectArgs;
14
+ validation?: "success" | "warning" | "error";
15
+ hasHelpText?: boolean;
16
+ }
17
+ export declare const Default: Story<MenuStoryArgs>;
18
+ export declare const Validation: Story<MenuStoryArgs>;
19
+ declare const _default: ComponentMeta<(props: import("react").PropsWithChildren<DropdownArgs>) => JSX.Element>;
20
+ export default _default;
@@ -0,0 +1,8 @@
1
+ import { ICheckboxProps } from "@zendeskgarden/react-forms";
2
+ export interface CheckboxArgs extends ICheckboxProps {
3
+ /**
4
+ * Sets the checkbox state to
5
+ * [indeterminate](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#Indeterminate_state_checkboxes)
6
+ */
7
+ indeterminate?: boolean;
8
+ }
@@ -0,0 +1,14 @@
1
+ /// <reference types="react" />
2
+ import { CheckboxArgs } from "./_types";
3
+ /**
4
+ * A Checkbox lets users select and unselect options from a list.
5
+ * <hr>
6
+ * Used for this:
7
+ * - To let users compare options from a list and select all, any, or none of those items
8
+ * - To turn a single option on or off
9
+ * Not for this:
10
+ * - To give the user a mutually exclusive choice, use the Radio component instead
11
+ * - To let users activate an option that takes effect immediately, use a Toggle instead
12
+ **/
13
+ declare const Checkbox: (props: CheckboxArgs) => JSX.Element;
14
+ export { Checkbox };
@@ -0,0 +1,6 @@
1
+ /// <reference types="react" />
2
+ import { ComponentMeta, Story } from "@storybook/react";
3
+ import { CheckboxArgs } from "./_types";
4
+ export declare const Default: Story<CheckboxArgs>;
5
+ declare const _default: ComponentMeta<(props: CheckboxArgs) => JSX.Element>;
6
+ export default _default;
@@ -0,0 +1,3 @@
1
+ import { IFieldProps } from "@zendeskgarden/react-forms";
2
+ export interface FieldArgs extends IFieldProps {
3
+ }
@@ -0,0 +1,8 @@
1
+ /// <reference types="react" />
2
+ import { Hint as ZendeskHint } from "@zendeskgarden/react-forms";
3
+ import { FieldArgs } from "./_types";
4
+ /**
5
+ * A Field is a wrapper for input elements
6
+ **/
7
+ declare const Field: (props: FieldArgs) => JSX.Element;
8
+ export { Field, ZendeskHint as Hint };
@@ -0,0 +1,6 @@
1
+ /// <reference types="react" />
2
+ import { ComponentMeta, Story } from "@storybook/react";
3
+ import { FieldArgs } from "./_types";
4
+ export declare const Default: Story<FieldArgs>;
5
+ declare const _default: ComponentMeta<(props: FieldArgs) => JSX.Element>;
6
+ export default _default;
@@ -0,0 +1,9 @@
1
+ import { IInputProps } from "@zendeskgarden/react-forms";
2
+ export interface InputArgs extends IInputProps {
3
+ /** Removes borders and padding */
4
+ isBare?: boolean;
5
+ /** Applies inset `box-shadow` styling on focus */
6
+ focusInset?: boolean;
7
+ /** Applies validation state styling */
8
+ validation?: 'success' | 'warning' | 'error';
9
+ }
@@ -0,0 +1,11 @@
1
+ /// <reference types="react" />
2
+ import { InputArgs } from "./_types";
3
+ /**
4
+ * An Input lets users enter text into a field.
5
+ * <hr>
6
+ * Used for this:
7
+ * - To let the user enter data into a field
8
+ * - To enter multiline text, use a Textarea
9
+ **/
10
+ declare const Input: (props: InputArgs) => JSX.Element;
11
+ export { Input };
@@ -0,0 +1,9 @@
1
+ /// <reference types="react" />
2
+ import { ComponentMeta, Story } from "@storybook/react";
3
+ import { InputArgs } from "./_types";
4
+ export declare const Default: Story<InputArgs>;
5
+ export declare const Success: Story<InputArgs>;
6
+ export declare const Warning: Story<InputArgs>;
7
+ export declare const Error: Story<InputArgs>;
8
+ declare const _default: ComponentMeta<(props: InputArgs) => JSX.Element>;
9
+ export default _default;
@@ -0,0 +1,3 @@
1
+ import { IRadioProps } from "@zendeskgarden/react-forms";
2
+ export interface RadioArgs extends IRadioProps {
3
+ }
@@ -0,0 +1,14 @@
1
+ /// <reference types="react" />
2
+ import { RadioArgs } from "./_types";
3
+ /**
4
+ * Radio buttons let users choose a single option among two or more mutually exclusive options.
5
+ * <hr>
6
+ * Used for this:
7
+ * - For choices or options that can't occur at the same time
8
+ * - To indicate that two or more options are mutually exclusive
9
+ * Not for this:
10
+ * - If the user can choose more than one option at once, use a Checkbox instead
11
+ * - To select from a long list of options, use Select instead
12
+ **/
13
+ declare const Radio: (props: RadioArgs) => JSX.Element;
14
+ export { Radio };
@@ -0,0 +1,7 @@
1
+ /// <reference types="react" />
2
+ import { ComponentMeta, Story } from "@storybook/react";
3
+ import { RadioArgs } from "./_types";
4
+ export declare const Default: Story<RadioArgs>;
5
+ export declare const Checked: Story<RadioArgs>;
6
+ declare const _default: ComponentMeta<(props: RadioArgs) => JSX.Element>;
7
+ export default _default;
@@ -0,0 +1,15 @@
1
+ import { ITextareaProps } from "@zendeskgarden/react-forms";
2
+ export interface TextareaArgs extends ITextareaProps {
3
+ /** Removes borders and padding */
4
+ isBare?: boolean;
5
+ /** Applies inset `box-shadow` styling on focus */
6
+ focusInset?: boolean;
7
+ /** Enables manual vertical resize */
8
+ isResizable?: boolean;
9
+ /** Defines the minimum height in rows */
10
+ minRows?: number;
11
+ /** Defines the maximum height in rows */
12
+ maxRows?: number;
13
+ /** Applies validation state styling */
14
+ validation?: 'success' | 'warning' | 'error';
15
+ }
@@ -0,0 +1,10 @@
1
+ /// <reference types="react" />
2
+ import { TextareaArgs } from "./_types";
3
+ /**
4
+ * A Textarea is a form control for multi-line text.
5
+ * <hr>
6
+ * Used for this:
7
+ * - To enter multi-line text
8
+ **/
9
+ declare const Textarea: (props: TextareaArgs) => JSX.Element;
10
+ export { Textarea };
@@ -0,0 +1,8 @@
1
+ /// <reference types="react" />
2
+ import { ComponentMeta, Story } from "@storybook/react";
3
+ import { TextareaArgs } from "./_types";
4
+ export declare const Default: Story<TextareaArgs>;
5
+ export declare const Warning: Story<TextareaArgs>;
6
+ export declare const Resize: Story<TextareaArgs>;
7
+ declare const _default: ComponentMeta<(props: TextareaArgs) => JSX.Element>;
8
+ export default _default;
@@ -0,0 +1,3 @@
1
+ import { IToggleProps } from "@zendeskgarden/react-forms";
2
+ export interface ToggleArgs extends IToggleProps {
3
+ }
@@ -0,0 +1,13 @@
1
+ /// <reference types="react" />
2
+ import { ToggleArgs } from "./_types";
3
+ /**
4
+ * A Toggle lets users turn something on and off like a light switch. Unlike a Checkbox, which is used for selection, a Toggle is used for activation.
5
+ * <hr>
6
+ * Used for this:
7
+ * - To see or compare the results of a settings change
8
+ * - To activate a mode (such as "dark mode") which takes immediate effect
9
+ * Not for this:
10
+ * - To let users select from a list of settings, use Checkboxes instead
11
+ **/
12
+ declare const Toggle: (props: ToggleArgs) => JSX.Element;
13
+ export { Toggle };
@@ -0,0 +1,10 @@
1
+ /// <reference types="react" />
2
+ import { ComponentMeta, Story } from "@storybook/react";
3
+ import { LabelArgs } from "../../label/_types";
4
+ import { ToggleArgs } from "./_types";
5
+ interface ToggleStoryProps extends ToggleArgs {
6
+ label: LabelArgs;
7
+ }
8
+ export declare const Default: Story<ToggleStoryProps>;
9
+ declare const _default: ComponentMeta<(props: ToggleArgs) => JSX.Element>;
10
+ export default _default;
@@ -0,0 +1,77 @@
1
+ import { IColProps, GRID_NUMBER, BREAKPOINT, ALIGN_SELF, TEXT_ALIGN } from "@zendeskgarden/react-grid";
2
+ export interface ColArgs extends IColProps {
3
+ /** Sets the total number of grid `columns` that the column spans on all screen sizes */
4
+ size?: GRID_NUMBER;
5
+ /** Defines the column size on extra-small screens.
6
+ * See [breakpoints](/components/theme-object#default_theme).
7
+ */
8
+ xs?: BREAKPOINT;
9
+ /** Defines the column size on small screens*/
10
+ sm?: BREAKPOINT;
11
+ /** Defines the column size on medium screens */
12
+ md?: BREAKPOINT;
13
+ /** Defines the column size on large screens */
14
+ lg?: BREAKPOINT;
15
+ /** Defines the column size on extra-large screens */
16
+ xl?: BREAKPOINT;
17
+ /**
18
+ * Applies the `align-self` flex item property, overriding `Row alignItems`
19
+ * vertical alignment on all screen sizes
20
+ */
21
+ alignSelf?: ALIGN_SELF;
22
+ /** Applies the `align-self` flex item property to the column on extra-small screens */
23
+ alignSelfXs?: ALIGN_SELF;
24
+ /** Applies the `align-self` flex item property to the column on small screens */
25
+ alignSelfSm?: ALIGN_SELF;
26
+ /** Applies the `align-self` flex item property to the column on medium screens */
27
+ alignSelfMd?: ALIGN_SELF;
28
+ /** Applies the `align-self` flex item property to the column on large screens */
29
+ alignSelfLg?: ALIGN_SELF;
30
+ /** Applies the `align-self` flex item property to the column on extra-large screens */
31
+ alignSelfXl?: ALIGN_SELF;
32
+ /**
33
+ * Applies the RTL-aware `text-align` property to the column on all screen sizes
34
+ */
35
+ textAlign?: TEXT_ALIGN;
36
+ /** Applies the `text-align` property to the column on extra-small screens */
37
+ textAlignXs?: TEXT_ALIGN;
38
+ /** Applies the `text-align` property to the column on small screens */
39
+ textAlignSm?: TEXT_ALIGN;
40
+ /** Applies the `text-align` property to the column on medium screens */
41
+ textAlignMd?: TEXT_ALIGN;
42
+ /** Applies the `text-align` property to the column on large screens */
43
+ textAlignLg?: TEXT_ALIGN;
44
+ /** Applies the `text-align` property to the column on extra-large screens */
45
+ textAlignXl?: TEXT_ALIGN;
46
+ /**
47
+ * Offsets the column relative to the total number of `columns` in the
48
+ * grid on all screen sizes
49
+ */
50
+ offset?: GRID_NUMBER;
51
+ /** Applies offset to the column on extra-small screens */
52
+ offsetXs?: GRID_NUMBER;
53
+ /** Applies offset to the column on small screens */
54
+ offsetSm?: GRID_NUMBER;
55
+ /** Applies offset to the column on medium screens */
56
+ offsetMd?: GRID_NUMBER;
57
+ /** Applies offset to the column on large screens */
58
+ offsetLg?: GRID_NUMBER;
59
+ /** Applies offset to the column on extra-large screens */
60
+ offsetXl?: GRID_NUMBER;
61
+ /**
62
+ * Applies the `order` flex item property to the column on all screen sizes. Note that
63
+ * order modification can introduce accessibility problems by
64
+ * confusing tab ordering. Rely on semantic DOM ordering whenever possible.
65
+ */
66
+ order?: GRID_NUMBER;
67
+ /** Sets the `order` flex item property of the column on extra-small screens */
68
+ orderXs?: GRID_NUMBER;
69
+ /** Sets the `order` flex item property of the column on small screens */
70
+ orderSm?: GRID_NUMBER;
71
+ /** Sets the `order` flex item property of the column on medium screens */
72
+ orderMd?: GRID_NUMBER;
73
+ /** Sets the `order` flex item property of the column on large screens */
74
+ orderLg?: GRID_NUMBER;
75
+ /** Sets the `order` flex item property of the column on extra-large screens */
76
+ orderXl?: GRID_NUMBER;
77
+ }
@@ -0,0 +1,4 @@
1
+ /// <reference types="react" />
2
+ import { ColArgs } from "./_types";
3
+ declare const Col: (props: ColArgs) => JSX.Element;
4
+ export { Col };
@@ -0,0 +1,8 @@
1
+ /// <reference types="react" />
2
+ import { ComponentMeta, Story } from "@storybook/react";
3
+ import { ColArgs } from "./_types";
4
+ export declare const Basic: Story<(props: ColArgs) => JSX.Element>;
5
+ export declare const Breaks: Story<(props: ColArgs) => JSX.Element>;
6
+ export declare const Offset: Story<(props: ColArgs) => JSX.Element>;
7
+ declare const _default: ComponentMeta<(props: ColArgs) => JSX.Element>;
8
+ export default _default;
@@ -0,0 +1,9 @@
1
+ import { IGridProps, GRID_NUMBER, SPACE } from "@zendeskgarden/react-grid";
2
+ export interface GridArgs extends IGridProps {
3
+ /** Defines the number of individual columns that the grid contains */
4
+ columns?: GRID_NUMBER;
5
+ /** Specifies the grid column gutter width. The value `false` collapses the gutters */
6
+ gutters?: SPACE;
7
+ /** Highlights the columns for layout debugging */
8
+ debug?: boolean;
9
+ }
@@ -0,0 +1,10 @@
1
+ /// <reference types="react" />
2
+ import { GridArgs } from './_types';
3
+ /**
4
+ * The Grid component is a framework for building modular layouts.
5
+ * <hr>
6
+ * Used for this:
7
+ - To structure the layout of a page
8
+ */
9
+ declare const Grid: (props: GridArgs) => JSX.Element;
10
+ export { Grid };
@@ -0,0 +1,12 @@
1
+ /// <reference types="react" />
2
+ import { ComponentMeta, Story } from "@storybook/react";
3
+ import { RowStoryArg } from "../row/index.stories";
4
+ import { GridArgs } from "./_types";
5
+ interface GridProps extends GridArgs {
6
+ rows: Array<RowStoryArg>;
7
+ }
8
+ export declare const Default: Story<GridProps>;
9
+ export declare const EqualColumns: Story<GridProps>;
10
+ export declare const OneWiderColumn: Story<GridProps>;
11
+ declare const _default: ComponentMeta<(props: GridArgs) => JSX.Element>;
12
+ export default _default;
@@ -0,0 +1,48 @@
1
+ import { IRowProps, ALIGN_ITEMS, JUSTIFY_CONTENT, WRAP } from "@zendeskgarden/react-grid";
2
+ export interface RowArgs extends IRowProps {
3
+ /**
4
+ * Applies the `align-items` flex container property to the row.
5
+ * This affects vertical `Col` alignment on all screen sizes.
6
+ */
7
+ alignItems?: ALIGN_ITEMS;
8
+ /** Applies the `align-items` flex container property to the row on extra-small screens */
9
+ alignItemsXs?: ALIGN_ITEMS;
10
+ /** Applies the `align-items` flex container property to the row on small screens */
11
+ alignItemsSm?: ALIGN_ITEMS;
12
+ /** Applies the `align-items` flex container property to the row on medium screens */
13
+ alignItemsMd?: ALIGN_ITEMS;
14
+ /** Applies the `align-items` flex container property to the row on large screens */
15
+ alignItemsLg?: ALIGN_ITEMS;
16
+ /** Applies the `align-items` flex container property to the row on extra-large screens */
17
+ alignItemsXl?: ALIGN_ITEMS;
18
+ /**
19
+ * Applies the `justify-content` flex container property to the row.
20
+ * This affects horizontal `Col` alignment on all screen sizes.
21
+ */
22
+ justifyContent?: JUSTIFY_CONTENT;
23
+ /** Applies the `justify-content` flex container property to the row on extra-small screens */
24
+ justifyContentXs?: JUSTIFY_CONTENT;
25
+ /** Applies the `justify-content` flex container property to the row on small screens */
26
+ justifyContentSm?: JUSTIFY_CONTENT;
27
+ /** Applies the `justify-content` flex container property to the row on medium screens */
28
+ justifyContentMd?: JUSTIFY_CONTENT;
29
+ /** Applies the `justify-content` flex container property to the row on large screens */
30
+ justifyContentLg?: JUSTIFY_CONTENT;
31
+ /** Applies the `justify-content` flex container property to the row on extra-large screens */
32
+ justifyContentXl?: JUSTIFY_CONTENT;
33
+ /**
34
+ * Applies the `flex-wrap` container property to the row. This affects `Col` wrapping on
35
+ * all screen sizes.
36
+ */
37
+ wrap?: WRAP;
38
+ /** Applies the `flex-wrap` container property to the row on extra-small screens */
39
+ wrapXs?: WRAP;
40
+ /** Applies the `flex-wrap` container property to the row on small screens */
41
+ wrapSm?: WRAP;
42
+ /** Applies the `flex-wrap` container property to the row on medium screens */
43
+ wrapMd?: WRAP;
44
+ /** Applies the `flex-wrap` container property to the row on large screens */
45
+ wrapLg?: WRAP;
46
+ /** Applies the `flex-wrap` container property to the row on extra-large screens */
47
+ wrapXl?: WRAP;
48
+ }
@@ -0,0 +1,4 @@
1
+ /// <reference types="react" />
2
+ import { RowArgs } from "./_types";
3
+ declare const Row: (props: RowArgs) => JSX.Element;
4
+ export { Row };
@@ -0,0 +1,10 @@
1
+ /// <reference types="react" />
2
+ import { ComponentMeta, Story } from "@storybook/react";
3
+ import { RowArgs } from "./_types";
4
+ import { ColArgs } from "../col/_types";
5
+ export interface RowStoryArg extends RowArgs {
6
+ cols: Array<ColArgs>;
7
+ }
8
+ export declare const Basic: Story<RowStoryArg>;
9
+ declare const _default: ComponentMeta<(props: RowArgs) => JSX.Element>;
10
+ export default _default;
@@ -0,0 +1,7 @@
1
+ import { SVGProps } from "react";
2
+ export interface IconArgs extends SVGProps<SVGSVGElement> {
3
+ /** Specifies the icon type */
4
+ type: 'square' | 'triangle' | 'circle';
5
+ /** Specifies icon size */
6
+ size?: number;
7
+ }
@@ -0,0 +1,4 @@
1
+ /// <reference types="react" />
2
+ import { IconArgs } from './_types';
3
+ declare const Icon: (props: IconArgs) => JSX.Element;
4
+ export { Icon };
@@ -0,0 +1,6 @@
1
+ /// <reference types="react" />
2
+ import { ComponentMeta, Story } from "@storybook/react";
3
+ import { IconArgs } from "./_types";
4
+ export declare const Default: Story<IconArgs>;
5
+ declare const _default: ComponentMeta<(props: IconArgs) => JSX.Element>;
6
+ export default _default;
@@ -0,0 +1,5 @@
1
+ import { ILabelProps } from "@zendeskgarden/react-forms";
2
+ export interface LabelArgs extends ILabelProps {
3
+ /** Applies regular (non-bold) font weight */
4
+ isRegular?: boolean;
5
+ }
@@ -0,0 +1,8 @@
1
+ /// <reference types="react" />
2
+ import { LabelArgs } from "./_types";
3
+ /**
4
+ * A Label is used to specify a title for an input.
5
+ * <hr>
6
+ **/
7
+ declare const Label: (props: LabelArgs) => JSX.Element;
8
+ export { Label };
@@ -0,0 +1,7 @@
1
+ /// <reference types="react" />
2
+ import { ComponentMeta, Story } from "@storybook/react";
3
+ import { LabelArgs } from "./_types";
4
+ export declare const Basic: Story<LabelArgs>;
5
+ export declare const Bold: Story<LabelArgs>;
6
+ declare const _default: ComponentMeta<(props: LabelArgs) => JSX.Element>;
7
+ export default _default;
@@ -0,0 +1,12 @@
1
+ import { IProgressProps } from '@zendeskgarden/react-loaders';
2
+ export interface ProgressArgs extends IProgressProps {
3
+ /** Sets the progress as a value between 0 and 100 */
4
+ value?: number;
5
+ /**
6
+ * Sets the foreground bar's fill color.
7
+ * Defaults to the `successHue` [theme](/components/theme-object#colors) value.
8
+ */
9
+ color?: string;
10
+ /** Adjusts the height */
11
+ size?: 'small' | 'medium' | 'large';
12
+ }
@@ -0,0 +1,14 @@
1
+ /// <reference types="react" />
2
+ import { ProgressArgs } from './_types';
3
+ /**
4
+ * A Progress loader communicates progress when downloading or uploading content.
5
+ * <hr>
6
+ * Used for this:
7
+ * - To communicate the amount of time left when downloading or uploading content
8
+ *
9
+ Not for this:
10
+ - When the loading time is unknown, use a Spinner instead
11
+ - When loading page content, use a Skeleton loader instead
12
+ */
13
+ declare const Progress: (props: ProgressArgs) => JSX.Element;
14
+ export { Progress };
@@ -0,0 +1,6 @@
1
+ /// <reference types="react" />
2
+ import { ComponentMeta, Story } from "@storybook/react";
3
+ import { ProgressArgs } from "./_types";
4
+ export declare const Default: Story<ProgressArgs>;
5
+ declare const _default: ComponentMeta<(props: ProgressArgs) => JSX.Element>;
6
+ export default _default;
@@ -0,0 +1,9 @@
1
+ import { ISkeletonProps } from '@zendeskgarden/react-loaders';
2
+ export interface SkeletonArgs extends ISkeletonProps {
3
+ /** Sets the width in px or in percentage of the the parent element's width */
4
+ width?: string;
5
+ /** Sets the height in px or in percentage of parent element's height if the height is not already inherited by `line-height` */
6
+ height?: string;
7
+ /** Inverts the color for use on dark backgrounds */
8
+ isLight?: boolean;
9
+ }
@@ -0,0 +1,17 @@
1
+ /// <reference types="react" />
2
+ import { SkeletonArgs } from './_types';
3
+ /**
4
+ * A Skeleton loader shows users a blank version of a page or section of a page into which content is gradually loaded. It provides a visual estimate of the space needed.
5
+ * <hr>
6
+ * Used for this:
7
+ - Skeleton is the default loader, used whenever the system can predict the format of the loading content
8
+ - To progressively load different parts of a page
9
+ - To avoid large layout shifts
10
+
11
+ * Not for this:
12
+ - When the system doesn’t have control over the content that is loading, use a Spinner instead
13
+ - To indicate that a component (like a button or search input) is busy, use Dots instead
14
+ - To communicate a typing status, use Inline instead
15
+ */
16
+ declare const Skeleton: (props: SkeletonArgs) => JSX.Element;
17
+ export { Skeleton };
@@ -0,0 +1,7 @@
1
+ /// <reference types="react" />
2
+ import { ComponentMeta, Story } from "@storybook/react";
3
+ import { SkeletonArgs } from "./_types";
4
+ export declare const Default: Story<SkeletonArgs>;
5
+ export declare const Light: Story<SkeletonArgs>;
6
+ declare const _default: ComponentMeta<(props: SkeletonArgs) => JSX.Element>;
7
+ export default _default;