@react-types/breadcrumbs - npm Package Compare versions

Comparing version 3.0.0-alpha.1 to 3.0.0-rc.0

package.json

 {
   "name": "@react-types/breadcrumbs",
-  "version": "3.0.0-alpha.1",
+  "version": "3.0.0-rc.0",
   "description": "Spectrum UI components in React",
@@ -12,3 +12,3 @@ "license": "Apache-2.0",
   "dependencies": {
-    "@react-types/shared": "^3.0.0-rc.2"
+    "@react-types/shared": "3.0.0-rc.3"
   },
@@ -21,3 +21,3 @@ "peerDependencies": {
   },
-  "gitHead": "207e6ee9076905c96638a7f81a367758872e1410"
+  "gitHead": "461d6321126ae9b4f1508aa912f7b36bf8a603f8"
 }

src/index.d.ts

@@ -13,3 +13,3 @@ /*
 
-import {DOMProps, PressEvents, StyleProps} from '@react-types/shared';
+import {AriaLabelingProps, DOMProps, PressEvents, StyleProps} from '@react-types/shared';
 import {ItemProps} from '@react-types/shared';
@@ -19,7 +19,12 @@ import {Key, ReactElement, ReactNode} from 'react';
 export interface BreadcrumbItemProps extends PressEvents {
+  /** Whether the breadcrumb item represents the current page. */
   isCurrent?: boolean,
-  isHeading?: boolean,
+  /**
+   * The type of current location the breadcrumb item represents, if `isCurrent` is true.
+   * @default 'page'
+   */
+  'aria-current'?: 'page' | 'step' | 'location' | 'date' | 'time' | boolean | 'true' | 'false',
+  /** Whether the breadcrumb item is disabled. */
   isDisabled?: boolean,
-  headingAriaLevel?: number,
-  'aria-current'?: 'page' | 'step' | 'location' | 'date' | 'time' | boolean | 'true' | 'false',
+  /** The contents of the breadcrumb item. */
   children: ReactNode
@@ -29,13 +34,24 @@ }
 export interface BreadcrumbsProps<T> {
+  /** The breadcrumb items. */
   children: ReactElement<ItemProps<T>> | ReactElement<ItemProps<T>>[],
-  maxVisibleItems?: 'auto' | number,
+  /** Whether the Breadcrumbs are disabled. */
+  isDisabled?: boolean,
+  /** Called when an item is acted upon (usually selection via press). */
   onAction?: (key: Key) => void
 }
 
-export interface SpectrumBreadcrumbsProps<T> extends BreadcrumbsProps<T>, DOMProps, StyleProps {
+export interface AriaBreadcrumbsProps<T> extends BreadcrumbsProps<T>, DOMProps, AriaLabelingProps {}
+
+export interface SpectrumBreadcrumbsProps<T> extends AriaBreadcrumbsProps<T>, StyleProps {
+  /**
+   * Size of the Breadcrumbs including spacing and layout.
+   * @default 'L'
+   */
   size?: 'S' | 'M' | 'L',
-  isHeading?: boolean,
-  headingAriaLevel?: number,
+  /** Whether to always show the root item if the items are collapsed. */
   showRoot?: boolean,
-  isDisabled?: boolean
+  /**
+   * Whether to place the last Breadcrumb item onto a new line.
+   */
+  isMultiline?: boolean
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14143

increased by4.98%

Lines of code

49

increased by44.12%

Dependency changes

• + Added@react-types/shared@3.0.0-rc.3(transitive)

• - Removed@react-types/shared@3.25.0(transitive)

• Updated@react-types/shared@3.0.0-rc.3