@shopify/polaris-types 1.0.0 → 1.0.1

package/README.md

@@ -1,6 +1,6 @@
 # @shopify/polaris-types
 
-Type definitions for App Bridge UI.
+Type definitions for [Polaris web components](https://shopify.dev/docs/api/app-home/polaris-web-components).
 
 ## Installation
 
@@ -12,7 +12,7 @@ npm i -D @shopify/polaris-types
 
 ## Usage
 
-Since App Bridge UI is not imported directly, you need to add the types to your TypeScript configuration in one of the following ways:
+Since Polaris web components are not imported directly, you need to add the types to your TypeScript configuration in one of the following ways:
 
 ### Method 1: Add to tsconfig.json
 

package/dist/polaris.d.ts

@@ -3408,6 +3408,15 @@ interface ReactProps$M extends Partial<ChoiceProps>, Pick<ChoiceProps$1, 'id' |
      * any markup or element structure is ignored.
      */
     children?: ComponentChildren$1;
+    /**
+     * Additional text to provide context or guidance for the input.
+     *
+     * This text is displayed along with the input and its label
+     * to offer more information or instructions to the user.
+     *
+     * @implementation this content should be linked to the input with an `aria-describedby` attribute.
+     */
+    details?: ComponentChildren$1;
 }
 
 declare class Choice extends PreactCustomElement implements ChoiceProps {
@@ -3703,7 +3712,7 @@ declare global {
 declare module 'preact' {
     namespace createElement.JSX {
         interface IntrinsicElements {
-            [tagName$H]: ReactProps$H;
+            [tagName$H]: ReactProps$H & PreactBaseElementProps<ColorPicker>;
         }
     }
 }
@@ -3741,7 +3750,7 @@ declare global {
 declare module 'preact' {
     namespace createElement.JSX {
         interface IntrinsicElements {
-            [tagName$G]: ReactProps$G;
+            [tagName$G]: ReactProps$G & PreactBaseElementProps<DateField>;
         }
     }
 }
@@ -3871,7 +3880,7 @@ declare class DropZone extends BaseClass implements DropZoneProps {
     oninput: CallbackEventListener<typeof tagName$D>;
     ondroprejected: CallbackEventListener<typeof tagName$D>;
     get value(): string;
-    /** This sets the input value for a fiel type, which cannot be set programatically, so it can only be reset. */
+    /** This sets the input value for a file type, which cannot be set programatically, so it can only be reset. */
     set value(value: '' | null);
     get files(): File[];
     set files(files: File[]);
@@ -3891,7 +3900,7 @@ declare global {
 declare module 'preact' {
     namespace createElement.JSX {
         interface IntrinsicElements {
-            [tagName$D]: ReactProps$D;
+            [tagName$D]: ReactProps$D & PreactBaseElementProps<DropZone>;
         }
     }
 }
@@ -4084,11 +4093,7 @@ declare module 'preact' {
     }
 }
 
-type RequiredHeadingProps = Required<HeadingProps$1>;
-interface HeadingProps extends Pick<HeadingProps$1, 'accessibilityRole' | 'accessibilityVisibility' | 'lineClamp'> {
-    accessibilityRole: RequiredHeadingProps['accessibilityRole'];
-    accessibilityVisibility: RequiredHeadingProps['accessibilityVisibility'];
-    lineClamp: RequiredHeadingProps['lineClamp'];
+interface HeadingProps extends Required<Pick<HeadingProps$1, 'accessibilityRole' | 'accessibilityVisibility' | 'lineClamp'>> {
 }
 
 declare const tagName$z = "s-heading";
@@ -4319,7 +4324,7 @@ declare global {
 declare module 'preact' {
     namespace createElement.JSX {
         interface IntrinsicElements {
-            [tagName$u]: ReactProps$u;
+            [tagName$u]: ReactProps$u & PreactBaseElementPropsWithChildren<Menu>;
         }
     }
 }
@@ -4393,10 +4398,11 @@ declare global {
 
 declare const hasOpenChildModal: unique symbol;
 
-declare const open: unique symbol;
 declare const show: unique symbol;
 declare const hide: unique symbol;
+declare const isOpen: unique symbol;
 declare const dialog: unique symbol;
+declare const dismiss: unique symbol;
 declare const focusedElement: unique symbol;
 declare const onEscape: unique symbol;
 declare const nestedModals: unique symbol;
@@ -4433,7 +4439,9 @@ declare class Modal extends PreactOverlayElement implements ModalProps {
     /** @private */
     [onChildModalChange]: EventListenerOrEventListenerObject;
     /** @private */
-    get [open](): boolean;
+    get [isOpen](): boolean;
+    /** @private */
+    [dismiss](): void;
     /** @private */
     get [hasOpenChildModal](): boolean;
     /** @private */
@@ -4457,7 +4465,7 @@ declare global {
 declare module 'preact' {
     namespace createElement.JSX {
         interface IntrinsicElements {
-            [tagName$t]: Omit<ReactProps$t, 'primaryAction' | 'secondaryActions'>;
+            [tagName$t]: Omit<ReactProps$t, 'primaryAction' | 'secondaryActions'> & PreactBaseElementPropsWithChildren<Modal>;
         }
     }
 }
@@ -4673,7 +4681,6 @@ declare module 'preact' {
 
 interface ParagraphProps extends Required<Pick<ParagraphProps$1, 'accessibilityVisibility' | 'fontVariantNumeric' | 'tone' | 'dir' | 'color' | 'lineClamp'>> {
     color: Extract<ParagraphProps$1['color'], 'base' | 'subdued'>;
-    lineClamp: Extract<ParagraphProps$1['lineClamp'], number>;
 }
 
 declare const tagName$m = "s-paragraph";
@@ -4798,7 +4805,7 @@ declare global {
 declare module 'preact' {
     namespace createElement.JSX {
         interface IntrinsicElements {
-            [tagName$j]: ReactProps$j;
+            [tagName$j]: ReactProps$j & PreactBaseElementPropsWithChildren<QueryContainer>;
         }
     }
 }
@@ -5747,28 +5754,28 @@ declare global {
 declare module 'react' {
     namespace JSX {
         interface IntrinsicElements {
-            [tagName$H]: ReactProps$H;
+            [tagName$H]: ReactProps$H & ReactBaseElementProps<ColorPicker>;
         }
     }
 }
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            [tagName$H]: ReactProps$H;
+            [tagName$H]: ReactProps$H & ReactBaseElementProps<ColorPicker>;
         }
     }
 }
 declare module 'react' {
     namespace JSX {
         interface IntrinsicElements {
-            [tagName$G]: ReactProps$G;
+            [tagName$G]: ReactProps$G & ReactBaseElementProps<DateField>;
         }
     }
 }
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            [tagName$G]: ReactProps$G;
+            [tagName$G]: ReactProps$G & ReactBaseElementProps<DateField>;
         }
     }
 }
@@ -5803,14 +5810,14 @@ declare global {
 declare module 'react' {
     namespace JSX {
         interface IntrinsicElements {
-            [tagName$D]: ReactProps$D;
+            [tagName$D]: ReactProps$D & ReactBaseElementProps<DropZone>;
         }
     }
 }
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            [tagName$D]: ReactProps$D;
+            [tagName$D]: ReactProps$D & ReactBaseElementProps<DropZone>;
         }
     }
 }
@@ -5929,28 +5936,28 @@ declare global {
 declare module 'react' {
     namespace JSX {
         interface IntrinsicElements {
-            [tagName$u]: ReactProps$u;
+            [tagName$u]: ReactProps$u & ReactBaseElementPropsWithChildren<Menu>;
         }
     }
 }
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            [tagName$u]: ReactProps$u;
+            [tagName$u]: ReactProps$u & ReactBaseElementPropsWithChildren<Menu>;
         }
     }
 }
 declare module 'react' {
     namespace JSX {
         interface IntrinsicElements {
-            [tagName$t]: Omit<ReactProps$t, 'primaryAction' | 'secondaryActions'>;
+            [tagName$t]: Omit<ReactProps$t, 'primaryAction' | 'secondaryActions'> & ReactBaseElementPropsWithChildren<Modal>;
         }
     }
 }
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            [tagName$t]: Omit<ReactProps$t, 'primaryAction' | 'secondaryActions'>;
+            [tagName$t]: Omit<ReactProps$t, 'primaryAction' | 'secondaryActions'> & ReactBaseElementPropsWithChildren<Modal>;
         }
     }
 }
@@ -6083,14 +6090,14 @@ declare global {
 declare module 'react' {
     namespace JSX {
         interface IntrinsicElements {
-            [tagName$j]: ReactProps$j;
+            [tagName$j]: ReactProps$j & ReactBaseElementPropsWithChildren<QueryContainer>;
         }
     }
 }
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            [tagName$j]: ReactProps$j;
+            [tagName$j]: ReactProps$j & ReactBaseElementPropsWithChildren<QueryContainer>;
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopify/polaris-types",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "private": false,
   "publishConfig": {
     "access": "public",