@shopify/ui-extensions 2022.10.5 → 2023.4.0

package/build/ts/surfaces/admin/components/Select/Select.d.ts

@@ -0,0 +1,127 @@
+export interface SelectProps {
+    /**
+     * Whether the select can be changed.
+     */
+    disabled?: boolean;
+    /**
+     * Indicate an error to the user. The field will be given a specific stylistic treatment
+     * to communicate problems that have to be resolved immediately.
+     */
+    error?: string;
+    /**
+     * A unique identifier for the field. When no `id` is set,
+     * a globally unique value will be used instead.
+     */
+    id?: string;
+    /**
+     * Content to use as the field label.
+     */
+    label: string;
+    /**
+     * An identifier for the field that is unique within the nearest
+     * containing `Form` component.
+     */
+    name?: string;
+    /**
+     * Callback when focus is removed.
+     */
+    onBlur?(): void;
+    /**
+     * A callback that is run whenever the selected option changes. This callback
+     * is called with the string `value` of the selected `option`. This component
+     * is [controlled](https://reactjs.org/docs/forms.html#controlled-components),
+     * so you must store this value in state and reflect it back in the `value`
+     * prop of the select.
+     */
+    onChange?(value: string): void;
+    /**
+     * Callback when input is focused.
+     */
+    onFocus?(): void;
+    /**
+     * The options a user can select from.
+     *
+     * When both `options` and children `Option` or `OptionGroup` are provided,
+     * the options will be merged together, with the `options` property
+     * taking precedence.
+     */
+    options: (OptionDescription | OptionGroupDescription)[];
+    /**
+     * A short hint that describes the expected value of the field.
+     */
+    placeholder?: string;
+    /**
+     * Whether the field is read-only.
+     */
+    readOnly?: boolean;
+    /**
+     * Whether the field needs a value. This requirement adds semantic value
+     * to the field, but it will not cause an error to appear automatically.
+     * If you want to present an error when this field is empty, you can do
+     * so with the `error` prop.
+     */
+    required?: boolean;
+    /**
+     * The active option for the select. This should match to one of the
+     * `value` properties in the `options` property or one of the `<Option>`.
+     * When not set, the value will default to an empty string,
+     * which will show the `placeholder` text as the "selected value".
+     */
+    value?: string;
+}
+export interface OptionProps {
+    /**
+     * Whether this option can be selected or not.
+     */
+    disabled?: boolean;
+    /**
+     * The value that will be passed to the select’s `onChange` callback
+     * when this option is selected.
+     */
+    value: string;
+}
+export interface OptionGroupProps {
+    /**
+     * Whether the options within this group can be selected or not.
+     */
+    disabled?: boolean;
+    /**
+     * The user-facing label for this group of options.
+     */
+    label: string;
+}
+export interface OptionDescription {
+    /**
+     * Whether this option can be selected or not.
+     */
+    disabled?: boolean;
+    /**
+     * The user-facing label for this option.
+     */
+    label: string;
+    /**
+     * The value that will be passed to the select’s `onChange` callback
+     * when this option is selected.
+     */
+    value: string;
+}
+export interface OptionGroupDescription {
+    /**
+     * Whether the options within this group can be selected or not.
+     */
+    disabled?: boolean;
+    /**
+     * The user-facing label for this group of options.
+     */
+    label: string;
+    /**
+     * The options a user can select from.
+     */
+    options?: OptionDescription[];
+}
+export declare const Select: "Select" & {
+    readonly type?: "Select" | undefined;
+    readonly props?: SelectProps | undefined;
+    readonly children?: true | undefined;
+};
+//# sourceMappingURL=Select.d.ts.map

package/build/ts/surfaces/admin/components/Select/Select.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Select.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Select/Select.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,IAAI,IAAI,CAAC;IAEhB;;;;;;OAMG;IACH,QAAQ,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,IAAI,IAAI,CAAC;IAEjB;;;;;;OAMG;IACH,OAAO,EAAE,CAAC,iBAAiB,GAAG,sBAAsB,CAAC,EAAE,CAAC;IAExD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;CAC/B;AAED,eAAO,MAAM,MAAM;;;;CAAyD,CAAC"}

package/build/ts/surfaces/admin/components/Select/Select.doc.d.ts

@@ -0,0 +1,4 @@
+import { ReferenceEntityTemplateSchema } from '@shopify/generate-docs';
+declare const data: ReferenceEntityTemplateSchema;
+export default data;
+//# sourceMappingURL=Select.doc.d.ts.map

package/build/ts/surfaces/admin/components/Select/Select.doc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Select.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Select/Select.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAqCX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/components/Text/Text.d.ts

@@ -0,0 +1,97 @@
+type TextOverflow = 'ellipsis';
+type FontStyle = 'italic' | 'normal';
+type TextAccessibilityRole = 
+/**
+ * Indicate the text is contact information. Typically used for addresses.
+ */
+'address'
+/**
+ * Indicate the text has been deleted. Typically used for discounted prices.
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/del
+ */
+ | 'deletion'
+/**
+ * Indicate the text is marked or highlighted and relevant to the buyer’s current action.
+ * Typically used to indicate the characters that matched a search query.
+ * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/mark_role
+ */
+ | 'mark'
+/**
+ * Indicate emphatic stress. Typically for words that have a stressed emphasis compared to surrounding text.
+ *
+ * In an HTML host, the text will be rendered in a `<em>` tag.
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em
+ */
+ | 'emphasis'
+/**
+ * Indicate an offset from the normal prose of the text. Typically used to indicate
+ * a foreign word, fictional character thoughts, or when the text refers to the definition of a word
+ * instead of representing its semantic meaning.
+ *
+ * In an HTML host, the text will be rendered in a `<i>` tag.
+ */
+ | 'offset'
+/**
+ * Indicate strong importance, seriousness, or urgency.
+ *
+ * In an HTML host, the text will be rendered in a `<strong>` tag.
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strong
+ */
+ | 'strong';
+/**
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant
+ */
+type FontVariantOptions = 
+/**
+ * The `font-variant-numeric` CSS property controls the usage of alternate glyphs for numbers, fractions, and ordinal markers.
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric
+ */
+'numeric'
+/**
+ * The `font-variant-caps` CSS property controls the use of alternate glyphs for capital letters.
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-caps
+ */
+ | 'all-small-caps'
+/**
+ * Sets the value of the `font-variant-ligatures` as `none`,
+ * and the values of the other longhand properties as `normal`, their initial value.
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant#values
+ */
+ | 'none';
+type FontWeight = 'light-400' | 'light-300' | 'light-200' | 'light-100' | 'light' | 'base' | 'normal' | 'bold' | 'bold-100' | 'bold-200' | 'bold-300' | 'bold-400';
+export interface TextProps {
+    /** A unique identifier for the field. */
+    id?: string;
+    /**
+     * Sets the weight (or boldness) of the font.
+     * @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight
+     * */
+    fontWeight?: FontWeight;
+    /**
+     * Set how hidden overflow content is signaled to users.
+     * @see https://developer.mozilla.org/en-US/docs/Web/CSS/text-overflow
+     * */
+    textOverflow?: TextOverflow;
+    /**
+     * Set all the variants for a font with a shorthand property.
+     * @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant
+     */
+    fontVariant?: FontVariantOptions | FontVariantOptions[];
+    /**
+     *  Use to emphasize a word or a group of words.
+     * @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-style
+     */
+    fontStyle?: FontStyle;
+    /**
+     * Provide semantic meaning to content and improve support for assistive technologies.
+     * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles
+     */
+    accessibilityRole?: TextAccessibilityRole;
+}
+export declare const Text: "Text" & {
+    readonly type?: "Text" | undefined;
+    readonly props?: TextProps | undefined;
+    readonly children?: true | undefined;
+};
+export {};
+//# sourceMappingURL=Text.d.ts.map

package/build/ts/surfaces/admin/components/Text/Text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Text.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Text/Text.ts"],"names":[],"mappings":"AAEA,KAAK,YAAY,GAAG,UAAU,CAAC;AAE/B,KAAK,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAErC,KAAK,qBAAqB;AACxB;;GAEG;AACD,SAAS;AAEX;;;GAGG;GACD,UAAU;AAEZ;;;;GAIG;GACD,MAAM;AAER;;;;;GAKG;GACD,UAAU;AAEZ;;;;;;GAMG;GACD,QAAQ;AAEV;;;;;GAKG;GACD,QAAQ,CAAC;AAEb;;GAEG;AACH,KAAK,kBAAkB;AACrB;;;GAGG;AACD,SAAS;AACX;;;GAGG;GACD,gBAAgB;AAClB;;;;GAIG;GACD,MAAM,CAAC;AAEX,KAAK,UAAU,GACX,WAAW,GACX,WAAW,GACX,WAAW,GACX,WAAW,GAEX,OAAO,GACP,MAAM,GAEN,QAAQ,GAER,MAAM,GACN,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,CAAC;AAEf,MAAM,WAAW,SAAS;IACxB,yCAAyC;IACzC,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;SAGK;IACL,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;;SAGK;IACL,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B;;;OAGG;IACH,WAAW,CAAC,EAAE,kBAAkB,GAAG,kBAAkB,EAAE,CAAC;IAExD;;;OAGG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;CAC3C;AAED,eAAO,MAAM,IAAI;;;;CAAmD,CAAC"}

package/build/ts/surfaces/admin/components/Text/Text.doc.d.ts

@@ -0,0 +1,4 @@
+import { ReferenceEntityTemplateSchema } from '@shopify/generate-docs';
+declare const data: ReferenceEntityTemplateSchema;
+export default data;
+//# sourceMappingURL=Text.doc.d.ts.map

package/build/ts/surfaces/admin/components/Text/Text.doc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Text.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Text/Text.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAqCX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/components/TextArea/TextArea.d.ts

@@ -0,0 +1,15 @@
+import { AutocompleteProps, TextAutocompleteField, InputProps, MinMaxLengthProps } from '../shared';
+export interface TextAreaProps extends InputProps<string>, MinMaxLengthProps, AutocompleteProps<TextAutocompleteField> {
+    /**
+     * A number of visible text lines.
+     *
+     * @defaultValue 2
+     */
+    rows?: number;
+}
+export declare const TextArea: "TextArea" & {
+    readonly type?: "TextArea" | undefined;
+    readonly props?: TextAreaProps | undefined;
+    readonly children?: true | undefined;
+};
+//# sourceMappingURL=TextArea.d.ts.map

package/build/ts/surfaces/admin/components/TextArea/TextArea.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextArea.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/TextArea/TextArea.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,iBAAiB,EACjB,qBAAqB,EACrB,UAAU,EACV,iBAAiB,EAClB,MAAM,WAAW,CAAC;AAEnB,MAAM,WAAW,aACf,SAAQ,UAAU,CAAC,MAAM,CAAC,EACxB,iBAAiB,EACjB,iBAAiB,CAAC,qBAAqB,CAAC;IAC1C;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,eAAO,MAAM,QAAQ;;;;CAEpB,CAAC"}

package/build/ts/surfaces/admin/components/TextArea/TextArea.doc.d.ts

@@ -0,0 +1,4 @@
+import { ReferenceEntityTemplateSchema } from '@shopify/generate-docs';
+declare const data: ReferenceEntityTemplateSchema;
+export default data;
+//# sourceMappingURL=TextArea.doc.d.ts.map

package/build/ts/surfaces/admin/components/TextArea/TextArea.doc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextArea.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/TextArea/TextArea.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAqCX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/components/TextField/TextField.d.ts

@@ -0,0 +1,9 @@
+import { AutocompleteProps, TextAutocompleteField, InputProps, MinMaxLengthProps } from '../shared';
+export interface TextFieldProps extends InputProps<string>, MinMaxLengthProps, AutocompleteProps<TextAutocompleteField> {
+}
+export declare const TextField: "TextField" & {
+    readonly type?: "TextField" | undefined;
+    readonly props?: TextFieldProps | undefined;
+    readonly children?: true | undefined;
+};
+//# sourceMappingURL=TextField.d.ts.map

package/build/ts/surfaces/admin/components/TextField/TextField.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextField.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/TextField/TextField.ts"],"names":[],"mappings":"AACA,OAAO,EACL,iBAAiB,EACjB,qBAAqB,EACrB,UAAU,EACV,iBAAiB,EAClB,MAAM,WAAW,CAAC;AAEnB,MAAM,WAAW,cACf,SAAQ,UAAU,CAAC,MAAM,CAAC,EACxB,iBAAiB,EACjB,iBAAiB,CAAC,qBAAqB,CAAC;CAAG;AAE/C,eAAO,MAAM,SAAS;;;;CAErB,CAAC"}

package/build/ts/surfaces/admin/components/TextField/TextField.doc.d.ts

@@ -0,0 +1,4 @@
+import { ReferenceEntityTemplateSchema } from '@shopify/generate-docs';
+declare const data: ReferenceEntityTemplateSchema;
+export default data;
+//# sourceMappingURL=TextField.doc.d.ts.map

package/build/ts/surfaces/admin/components/TextField/TextField.doc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/TextField/TextField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAqCX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/components/URLField/URLField.d.ts

@@ -0,0 +1,10 @@
+import { AnyAutocompleteField, AutocompleteProps, AutocompleteAddressGroup, AutocompleteFieldInstantMessageAlias, InputProps, MinMaxLengthProps } from '../shared';
+export interface URLFieldProps extends InputProps<string>, MinMaxLengthProps, AutocompleteProps<URLAutocompleteField> {
+}
+export type URLAutocompleteField = Extract<AnyAutocompleteField, 'url' | 'photo' | `${AutocompleteFieldInstantMessageAlias}` | `${AutocompleteAddressGroup} ${AutocompleteFieldInstantMessageAlias}`>;
+export declare const URLField: "URLField" & {
+    readonly type?: "URLField" | undefined;
+    readonly props?: URLFieldProps | undefined;
+    readonly children?: true | undefined;
+};
+//# sourceMappingURL=URLField.d.ts.map

package/build/ts/surfaces/admin/components/URLField/URLField.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"URLField.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/URLField/URLField.ts"],"names":[],"mappings":"AACA,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,wBAAwB,EACxB,oCAAoC,EACpC,UAAU,EACV,iBAAiB,EAClB,MAAM,WAAW,CAAC;AAEnB,MAAM,WAAW,aACf,SAAQ,UAAU,CAAC,MAAM,CAAC,EACxB,iBAAiB,EACjB,iBAAiB,CAAC,oBAAoB,CAAC;CAAG;AAE9C,MAAM,MAAM,oBAAoB,GAAG,OAAO,CACxC,oBAAoB,EAClB,KAAK,GACL,OAAO,GACP,GAAG,oCAAoC,EAAE,GACzC,GAAG,wBAAwB,IAAI,oCAAoC,EAAE,CACxE,CAAC;AAEF,eAAO,MAAM,QAAQ;;;;CAEpB,CAAC"}

package/build/ts/surfaces/admin/components/URLField/URLField.doc.d.ts

@@ -0,0 +1,4 @@
+import { ReferenceEntityTemplateSchema } from '@shopify/generate-docs';
+declare const data: ReferenceEntityTemplateSchema;
+export default data;
+//# sourceMappingURL=URLField.doc.d.ts.map

package/build/ts/surfaces/admin/components/URLField/URLField.doc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"URLField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/URLField/URLField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAoCX,CAAC;AAEF,eAAe,IAAI,CAAC"}