@7shifts/sous-chef 4.7.1 → 4.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/dist/empty_states/EmptyState/EmptyState.d.ts +3 -0
  2. package/dist/empty_states/Paywall/Paywall.d.ts +3 -0
  3. package/dist/feedback/CircularProgress/CircularProgress.d.ts +3 -0
  4. package/dist/feedback/InlineBanner/InlineBanner.d.ts +3 -0
  5. package/dist/feedback/MicroBanner/MicroBanner.d.ts +3 -0
  6. package/dist/feedback/PersistentBanner/PersistentBanner.d.ts +3 -0
  7. package/dist/feedback/ProgressBar/ProgressBar.d.ts +3 -0
  8. package/dist/feedback/Skeleton/Skeleton.d.ts +3 -0
  9. package/dist/forms/ColorField/ColorField.d.ts +3 -0
  10. package/dist/forms/FormFeedback/FormFeedback.d.ts +3 -0
  11. package/dist/forms/FormFooter/FormFooter.d.ts +3 -0
  12. package/dist/forms/FormSection/FormSection.d.ts +3 -0
  13. package/dist/forms/PhoneField/PhoneField.d.ts +3 -0
  14. package/dist/forms/TextField/TextField.d.ts +3 -1
  15. package/dist/forms/WeekSelectField/WeekSelectField.d.ts +3 -0
  16. package/dist/icons/components/arrows/IconArrowLeftRight.d.ts +10 -0
  17. package/dist/icons/components/arrows/index.d.ts +1 -0
  18. package/dist/icons/components/communication/IconLanguage.d.ts +10 -0
  19. package/dist/icons/components/communication/index.d.ts +1 -0
  20. package/dist/icons/components/controls/IconInputText.d.ts +10 -0
  21. package/dist/icons/components/controls/IconListRadio.d.ts +10 -0
  22. package/dist/icons/components/controls/index.d.ts +2 -0
  23. package/dist/index.css +1 -1
  24. package/dist/index.css.map +1 -1
  25. package/dist/index.js +433 -152
  26. package/dist/index.js.map +1 -1
  27. package/dist/index.modern.js +430 -153
  28. package/dist/index.modern.js.map +1 -1
  29. package/dist/layout/Card/Card.d.ts +3 -0
  30. package/dist/layout/Page/Page.d.ts +3 -0
  31. package/dist/lists/Accordion/Accordion.d.ts +3 -0
  32. package/dist/lists/ActionList/ActionList.d.ts +3 -0
  33. package/dist/lists/DataTable/DataTable.d.ts +3 -0
  34. package/dist/media/Avatar/Avatar.d.ts +3 -0
  35. package/dist/media/Badge/Badge.d.ts +4 -1
  36. package/dist/media/Chip/Chip.d.ts +3 -0
  37. package/dist/media/Pill/Pill.d.ts +3 -0
  38. package/dist/navigation/Breadcrumbs/Breadcrumbs.d.ts +3 -0
  39. package/dist/navigation/PrimaryNav/PrimaryNav.d.ts +3 -0
  40. package/dist/navigation/Tabs/Tabs.d.ts +3 -0
  41. package/dist/overlay/Calendar/Calendar.d.ts +3 -1
  42. package/dist/overlay/Dropdown/Dropdown.d.ts +3 -0
  43. package/dist/overlay/HintModal/HintModal.d.ts +3 -0
  44. package/dist/overlay/Modal/Modal.d.ts +3 -0
  45. package/dist/overlay/Popover/Popover.d.ts +3 -0
  46. package/dist/overlay/Tooltip/Tooltip.d.ts +3 -0
  47. package/llms-instructions/guidelines/AsyncSelectField.guidelines.md +20 -0
  48. package/llms-instructions/guidelines/Avatar.guidelines.md +1 -0
  49. package/llms-instructions/guidelines/Breadcrumbs.guidelines.md +1 -0
  50. package/llms-instructions/guidelines/CheckboxField.guidelines.md +20 -0
  51. package/llms-instructions/guidelines/ColorField.guidelines.md +18 -0
  52. package/llms-instructions/guidelines/CurrencyField.guidelines.md +28 -0
  53. package/llms-instructions/guidelines/DateField.guidelines.md +22 -0
  54. package/llms-instructions/guidelines/DateRangeField.guidelines.md +21 -0
  55. package/llms-instructions/guidelines/MultiSelectField.guidelines.md +22 -0
  56. package/llms-instructions/guidelines/NumberField.guidelines.md +29 -0
  57. package/llms-instructions/guidelines/PaginationControls.guidelines.md +1 -0
  58. package/llms-instructions/guidelines/PasswordField.guidelines.md +20 -0
  59. package/llms-instructions/guidelines/PercentageField.guidelines.md +22 -0
  60. package/llms-instructions/guidelines/PhoneField.guidelines.md +23 -0
  61. package/llms-instructions/guidelines/PillSelectField.guidelines.md +22 -0
  62. package/llms-instructions/guidelines/RadioGroupField.guidelines.md +20 -0
  63. package/llms-instructions/guidelines/SelectField.guidelines.md +24 -0
  64. package/llms-instructions/guidelines/Tabs.guidelines.md +4 -0
  65. package/llms-instructions/guidelines/TextAreaField.guidelines.md +25 -0
  66. package/llms-instructions/guidelines/TextField.guidelines.md +22 -0
  67. package/llms-instructions/guidelines/TimeField.guidelines.md +23 -0
  68. package/llms-instructions/guidelines/TimeRangeField.guidelines.md +19 -0
  69. package/llms-instructions/guidelines/WeekField.guidelines.md +20 -0
  70. package/llms-instructions/guidelines/WeekSelectField.guidelines.md +1 -0
  71. package/llms-instructions/llms-components.md +80 -0
  72. package/package.json +1 -1
@@ -1,5 +1,8 @@
1
1
  import React from 'react';
2
2
  import { EmptyStateAsBanner, EmptyStateAsCard } from '../EmptyStateContainer/types';
3
3
  type Props = Omit<EmptyStateAsCard, 'isPaywall'> | Omit<EmptyStateAsBanner, 'isPaywall'>;
4
+ /**
5
+ * EmptyState component renders a message or illustration when there is no data to display. Most commonly seen in first time interactions with a product or page, but also when data’s been deleted or unavailable.
6
+ */
4
7
  declare const EmptyState: (props: Props) => React.JSX.Element;
5
8
  export default EmptyState;
@@ -1,5 +1,8 @@
1
1
  import React from 'react';
2
2
  import { EmptyStateAsBanner, EmptyStateAsCard } from '../EmptyStateContainer/types';
3
3
  type Props = Omit<EmptyStateAsCard, 'isPaywall'> | Omit<EmptyStateAsBanner, 'isPaywall'>;
4
+ /**
5
+ * Paywall is a specialised empty state for content that is locked behind a paid plan or add-on the user does not currently have.
6
+ */
4
7
  declare const Paywall: (props: Props) => React.JSX.Element;
5
8
  export default Paywall;
@@ -5,5 +5,8 @@ type Props = {
5
5
  children?: React.ReactNode;
6
6
  testId?: string;
7
7
  };
8
+ /**
9
+ * CircularProgress displays a circular track that fills as a count advances toward a total.
10
+ */
8
11
  declare const CircularProgress: ({ progress, maxValue, children, testId }: Props) => React.JSX.Element;
9
12
  export default CircularProgress;
@@ -19,5 +19,8 @@ type Props = {
19
19
  secondaryButton?: React.ReactElement;
20
20
  testId?: string;
21
21
  } & PositionStyles;
22
+ /**
23
+ * InlineBanner displays a contextual message inline within a page or section.
24
+ */
22
25
  declare const InlineBanner: React.FC<Props>;
23
26
  export default InlineBanner;
@@ -15,5 +15,8 @@ type Props = {
15
15
  primaryButton?: React.ReactElement;
16
16
  testId?: string;
17
17
  } & PositionStyles & DataProps;
18
+ /**
19
+ * MicroBanner is a compact notification component for tight spaces (like top bars).
20
+ */
18
21
  declare const MicroBanner: React.FC<Props>;
19
22
  export default MicroBanner;
@@ -9,5 +9,8 @@ type Props = {
9
9
  testId?: string;
10
10
  children: React.ReactNode;
11
11
  };
12
+ /**
13
+ * PersistentBanner displays a full-width message above the main navigation.
14
+ */
12
15
  declare const PersistentBanner: ({ theme, children, primaryButton, secondaryButton, onDismiss, onLoad, testId }: Props) => React.JSX.Element;
13
16
  export default PersistentBanner;
@@ -5,5 +5,8 @@ type Props = {
5
5
  testId?: string;
6
6
  steps?: string[];
7
7
  };
8
+ /**
9
+ * ProgressBar shows a horizontal bar that fills as a task advances.
10
+ */
8
11
  declare const ProgressBar: ({ progress, maxValue, testId, steps }: Props) => React.JSX.Element;
9
12
  export default ProgressBar;
@@ -10,5 +10,8 @@ type Props = {
10
10
  width?: string | number;
11
11
  testId?: string;
12
12
  } & PositionStyles;
13
+ /**
14
+ * Skeleton renders an animated placeholder that mirrors the shape of content while it is loading.
15
+ */
13
16
  declare const Skeleton: ({ as, testId, width, height, ...positionStyles }: Props) => React.JSX.Element;
14
17
  export default Skeleton;
@@ -1,5 +1,8 @@
1
1
  import React from 'react';
2
2
  import type { Props as TextFieldProps } from '../TextField/TextField';
3
+ /**
4
+ * ColorField is a text field that allows the user to select a color from a palette of sequential colors or a custom color picker.
5
+ */
3
6
  declare const ColorField: React.ForwardRefExoticComponent<{
4
7
  /** When true, allows the user to select a custom color */
5
8
  allowCustomColor?: boolean | undefined;
@@ -4,5 +4,8 @@ type Props = {
4
4
  fieldId?: string;
5
5
  testId?: string;
6
6
  };
7
+ /**
8
+ * FormFeedback displays contextual feedback for a form field, such as an error message or validation message.
9
+ */
7
10
  declare const FormFeedback: ({ children, fieldId, testId }: Props) => React.JSX.Element;
8
11
  export default FormFeedback;
@@ -8,5 +8,8 @@ type Props = {
8
8
  };
9
9
  testId?: string;
10
10
  };
11
+ /**
12
+ * FormFooter is meant to be used as the footer of a form, and it contains actions (primary, secondary, tertiary).
13
+ */
11
14
  declare const FormFooter: ({ children, actions, testId }: Props) => React.JSX.Element;
12
15
  export default FormFooter;
@@ -8,5 +8,8 @@ type Props = {
8
8
  /** When set `as="card"` it will render the form section in a card */
9
9
  as?: 'card';
10
10
  };
11
+ /**
12
+ * FormSection is a component that groups related form fields together, optionally with a title and subtitle. It can also be rendered as a card for visual separation.
13
+ */
11
14
  declare const FormSection: ({ children, title, subtitle, noMargin, testId, as }: Props) => React.JSX.Element;
12
15
  export default FormSection;
@@ -19,5 +19,8 @@ export type Props = {
19
19
  defaultCountry?: CountryCode;
20
20
  priorityCountries?: CountryCode[];
21
21
  };
22
+ /**
23
+ * PhoneField is a text field that allows the user to input a phone number, with an optional country selector for international numbers.
24
+ */
22
25
  declare const PhoneField: ({ disabledCountry, priorityCountries, ...props }: Props) => React.JSX.Element;
23
26
  export default PhoneField;
@@ -25,7 +25,9 @@ export type Props = {
25
25
  value?: string;
26
26
  testId?: string;
27
27
  } & DataProps;
28
- /** A basic open input field used to get text from the user, with options to add a prefix or suffix element if necessary. Accepts any characters, so do not use it if you want to limit the format of the input to numbers only. */
28
+ /**
29
+ * TextField is a basic open input field used to get text from the user, with options to add a prefix or suffix element if necessary. Accepts any characters, so do not use it if you want to limit the format of the input to numbers only.
30
+ */
29
31
  declare const TextField: React.ForwardRefExoticComponent<{
30
32
  autoComplete?: AutoCompleteType | undefined;
31
33
  autoFocus?: boolean | undefined;
@@ -13,5 +13,8 @@ type Props = {
13
13
  displayFormat?: 'weekday' | 'month';
14
14
  testId?: string;
15
15
  };
16
+ /**
17
+ * WeekSelectField is a form field that allows the user to select one or more days from a week, displayed as pill-shaped buttons.
18
+ */
16
19
  declare const WeekSelectField: ({ name, id: inputId, days, value: controlledValue, onChange, label, caption, error: errorProp, disabled, displayFormat, testId }: Props) => React.JSX.Element;
17
20
  export default WeekSelectField;
@@ -0,0 +1,10 @@
1
+ import React from 'react';
2
+ import { IconSize, IconVariant } from '../../types';
3
+ type Props = {
4
+ size?: IconSize;
5
+ color?: string;
6
+ testId?: string;
7
+ variant?: IconVariant;
8
+ } & React.SVGProps<SVGSVGElement>;
9
+ declare const IconArrowLeftRight: React.ForwardRefExoticComponent<Omit<Props, 'ref'>>;
10
+ export default IconArrowLeftRight;
@@ -1,6 +1,7 @@
1
1
  export { default as IconArrowDown } from './IconArrowDown';
2
2
  export { default as IconArrowDownWideShort } from './IconArrowDownWideShort';
3
3
  export { default as IconArrowLeft } from './IconArrowLeft';
4
+ export { default as IconArrowLeftRight } from './IconArrowLeftRight';
4
5
  export { default as IconArrowRight } from './IconArrowRight';
5
6
  export { default as IconArrowToTop } from './IconArrowToTop';
6
7
  export { default as IconArrowTurnDownRight } from './IconArrowTurnDownRight';
@@ -0,0 +1,10 @@
1
+ import React from 'react';
2
+ import { IconSize, IconVariant } from '../../types';
3
+ type Props = {
4
+ size?: IconSize;
5
+ color?: string;
6
+ testId?: string;
7
+ variant?: IconVariant;
8
+ } & React.SVGProps<SVGSVGElement>;
9
+ declare const IconLanguage: React.ForwardRefExoticComponent<Omit<Props, 'ref'>>;
10
+ export default IconLanguage;
@@ -5,6 +5,7 @@ export { default as IconCameraSlash } from './IconCameraSlash';
5
5
  export { default as IconComment } from './IconComment';
6
6
  export { default as IconCommentLines } from './IconCommentLines';
7
7
  export { default as IconEnvelope } from './IconEnvelope';
8
+ export { default as IconLanguage } from './IconLanguage';
8
9
  export { default as IconMessages } from './IconMessages';
9
10
  export { default as IconMicrophone } from './IconMicrophone';
10
11
  export { default as IconMobile } from './IconMobile';
@@ -0,0 +1,10 @@
1
+ import React from 'react';
2
+ import { IconSize, IconVariant } from '../../types';
3
+ type Props = {
4
+ size?: IconSize;
5
+ color?: string;
6
+ testId?: string;
7
+ variant?: IconVariant;
8
+ } & React.SVGProps<SVGSVGElement>;
9
+ declare const IconInputText: React.ForwardRefExoticComponent<Omit<Props, 'ref'>>;
10
+ export default IconInputText;
@@ -0,0 +1,10 @@
1
+ import React from 'react';
2
+ import { IconSize, IconVariant } from '../../types';
3
+ type Props = {
4
+ size?: IconSize;
5
+ color?: string;
6
+ testId?: string;
7
+ variant?: IconVariant;
8
+ } & React.SVGProps<SVGSVGElement>;
9
+ declare const IconListRadio: React.ForwardRefExoticComponent<Omit<Props, 'ref'>>;
10
+ export default IconListRadio;
@@ -13,10 +13,12 @@ export { default as IconFile } from './IconFile';
13
13
  export { default as IconGripVertical } from './IconGripVertical';
14
14
  export { default as IconHouse } from './IconHouse';
15
15
  export { default as IconImage } from './IconImage';
16
+ export { default as IconInputText } from './IconInputText';
16
17
  export { default as IconItalic } from './IconItalic';
17
18
  export { default as IconLink } from './IconLink';
18
19
  export { default as IconList } from './IconList';
19
20
  export { default as IconListOl } from './IconListOl';
21
+ export { default as IconListRadio } from './IconListRadio';
20
22
  export { default as IconLock } from './IconLock';
21
23
  export { default as IconMemoMagnifyingGlass } from './IconMemoMagnifyingGlass';
22
24
  export { default as IconMinus } from './IconMinus';
package/dist/index.css CHANGED
@@ -6041,7 +6041,7 @@ input._TEU6N {
6041
6041
  color: var(--color-upsell-on-container);
6042
6042
  }
6043
6043
  ._4M-yZ {
6044
- min-width: 40px;
6044
+ /* min-width: 40px; */
6045
6045
  }
6046
6046
  ._6bVLs {
6047
6047
  display: flex;