@shopify/ui-extensions - npm Package Compare versions

Comparing version 0.0.0-unstable-20230921140729 to 0.0.0-unstable-20230921160012

build/ts/surfaces/admin/components/AdminAction/AdminAction.d.ts

@@ -25,5 +25,7 @@ import type { RemoteFragment } from '@remote-ui/core';
     readonly type?: "AdminAction" | undefined;
-    readonly props?: AdminActionProps | undefined;
+    readonly props?: AdminActionProps | undefined; /**
+     * Sets the Primary action button of the container. This component must a button component.
+     */
     readonly children?: true | undefined;
 };
 //# sourceMappingURL=AdminAction.d.ts.map

build/ts/surfaces/admin/components/ResourceItem/ResourceItem.d.ts

@@ -15,4 +15,9 @@ export interface ResourceItemProps {
     readonly props?: ResourceItemProps | undefined;
+    /**
+     * Resource items represent specific objects within a collection, such as products or orders. They provide contextual information on the resource type and link to the object’s detail page.
+     *
+     * A `ResourceItem` should be rendered within a `ResourceList`.
+     */
     readonly children?: true | undefined;
 };
 //# sourceMappingURL=ResourceItem.d.ts.map

build/ts/surfaces/checkout/components/BlockSpacer/BlockSpacer.d.ts

@@ -20,4 +20,9 @@ import type { MaybeResponsiveConditionalStyle } from '../../style';
     readonly props?: BlockSpacerProps | undefined;
+    /**
+     * Adjust size of the spacer
+     *
+     * @defaultValue 'base'
+     **/
     readonly children?: false | undefined;
 };
 //# sourceMappingURL=BlockSpacer.d.ts.map

build/ts/surfaces/checkout/components/ProductThumbnail/ProductThumbnail.d.ts

@@ -75,21 +75,3 @@ import { MaybeConditionalStyle, ResolutionCondition } from '../../style';
 export declare const ProductThumbnail: "ProductThumbnail" & {
-    readonly type?: "ProductThumbnail" | undefined; /**
-     * An alternative text description that describe the image for the reader to
-     * understand what it is about. It is extremely useful for both users using
-     * assistive technology and sighted users. A well written description
-     * provides people with visual impairments the ability to participate in
-     * consuming non-text content. When a screen readers encounters an `Image`,
-     * the description is read and announced aloud. If an image fails to load,
-     * potentially due to a poor connection, the description is displayed on
-     * screen instead. This has the benefit of letting a sighted buyer know an
-     * image was meant to load here, but as an alternative, they’re still able to
-     * consume the text content. Read
-     * [considerations when writing alternative text](https://ux.shopify.com/considerations-when-writing-alt-text-a9c1985a8204)
-     * to learn more.
-     *
-     * This property is an alias for `accessibilityLabel` for compatibility with the HTML
-     * specification. When both are specified `accessibilityLabel` takes precedence.
-     *
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt
-     */
+    readonly type?: "ProductThumbnail" | undefined;
     readonly props?: ProductThumbnailProps | undefined;
@@ -96,0 +78,0 @@ readonly children?: true | undefined;

build/ts/surfaces/checkout/components/ScrollView/ScrollView.d.ts

@@ -1,2 +0,1 @@
-/// <reference types="react" />
 import { BorderProps, CornerProps, SizingProps, SpacingProps } from '../shared';
@@ -3,0 +2,0 @@ export interface ScrollViewEvent {

build/ts/surfaces/checkout/components/SkeletonText/SkeletonText.d.ts

@@ -23,4 +23,6 @@ import type { IdProps, TextSize, Size } from '../shared';
     readonly props?: SkeletonTextProps | undefined;
-    readonly children?: true | undefined;
+    readonly children?: true | undefined; /**
+     * Adjust the length of the text when no children are passed.
+     */
 };
 //# sourceMappingURL=SkeletonText.d.ts.map

build/ts/surfaces/checkout/components/SkeletonTextBlock/SkeletonTextBlock.d.ts

@@ -25,4 +25,8 @@ import type { IdProps, TextSize } from '../shared';
     readonly props?: SkeletonTextBlockProps | undefined;
-    readonly children?: true | undefined;
+    readonly children?: true | undefined; /**
+     * Number of lines to display when no children are passed.
+     *
+     * @defaultValue 1
+     */
 };
 //# sourceMappingURL=SkeletonTextBlock.d.ts.map

build/ts/surfaces/checkout/components/Tag/Tag.d.ts

@@ -23,5 +23,3 @@ import { IconSource } from '../Icon/Icon';
 export declare const Tag: "Tag" & {
-    readonly type?: "Tag" | undefined; /**
-     * Icon source
-     */
+    readonly type?: "Tag" | undefined;
     readonly props?: TagProps | undefined;
@@ -28,0 +26,0 @@ readonly children?: true | undefined;

build/ts/surfaces/checkout/components/TextBlock/TextBlock.d.ts

@@ -26,4 +26,6 @@ import type { Appearance, Emphasis, IdProps, InlineAlignment, TextSize } from '../shared';
     readonly props?: TextBlockProps | undefined;
-    readonly children?: true | undefined;
+    readonly children?: true | undefined; /**
+     * Use to emphasize a word or a group of words.
+     */
 };
 //# sourceMappingURL=TextBlock.d.ts.map

package.json

 {
   "name": "@shopify/ui-extensions",
-  "version": "0.0.0-unstable-20230921140729",
+  "version": "0.0.0-unstable-20230921160012",
   "scripts": {
@@ -56,3 +56,3 @@ "docs:admin": "sh ./docs/surfaces/admin/build-docs.sh \"admin\"",
     "@remote-ui/async-subscription": "^2.1.12",
-    "@remote-ui/core": "2.1.x"
+    "@remote-ui/core": "^2.2.3"
   },
@@ -59,0 +59,0 @@ "devDependencies": {

No alert changes

Worsened metrics

Total package byte prevSize

1430482

decreased by-0.01%

Lines of code

30146

Dependency changes

• + Added@remote-ui/core@2.2.5(transitive)

• - Removed@remote-ui/core@2.1.17(transitive)

• Updated@remote-ui/core@^2.2.3