@workday/canvas-kit-react 7.1.4 → 7.2.0-427-next.2

package/action-bar/lib/ActionBar.tsx

@@ -13,11 +13,55 @@ export interface ActionBarProps {
   children: React.ReactNode;
 }
 
+/**
+ * `ActionBar` is a container component that is responsible for creating an {@link ActionBarModel}
+ * and sharing it with its subcomponents using React context. It does not represent a real element.
+ *
+ * ```tsx
+ * <ActionBar items={[]}>{Child components}</ActionBar>
+ * ```
+ *
+ * Alternatively, you may pass in a model using the hoisted model pattern.
+ *
+ * ```tsx
+ * const model = useActionBarModel({
+ *   items: [],
+ * });
+ *
+ * <ActionBar model={model}>{Child components}</ActionBar>;
+ * ```
+ */
 export const ActionBar = createContainer()({
   displayName: 'ActionBar',
   modelHook: useActionBarModel,
   subComponents: {
+    /**
+     * `ActionBar.List` is a {@link Flex} element. It is a container for
+     * {@link ActionBarItem ActionBar.Item} subcomponents. To render an overflow button for
+     * ActionBar with overflow behavior `overflowButton` prop with overflow button component as a
+     * value should be passed.
+     *
+     * ```tsx
+     * // without overflow
+     * <ActionBar.List>{ActionBar.Items}</ActionBar.List>
+     *
+     * // with overflow
+     * <ActionBar.List overflowButton={<ActionBar.OverflowButton aria-label="More actions"/>}>
+     *   {ActionBar.Items}
+     * </ActionBar.List>
+     * ```
+     */
     List: ActionBarList,
+    /**
+     * `ActionBar.Item` is a `button` element, by default it's a `SecondaryButton` unless an `as`
+     * prop is passed.
+     *
+     * ```tsx
+     * <ActionBar.Item as={PrimaryButton} onClick={() => console.log('first action')}>
+     *   First Action
+     * </ActionBar.Item>
+     * ```
+     */
     Item: ActionBarItem,
     OverflowButton: ActionBarOverflowButton,
     /**

package/action-bar/lib/ActionBarItem.tsx

@@ -2,9 +2,8 @@ import * as React from 'react';
 import {composeHooks, createSubcomponent} from '@workday/canvas-kit-react/common';
 import {SecondaryButton} from '@workday/canvas-kit-react/button';
 import {
-  useListItemRegister,
-  useListItemRovingFocus,
   useOverflowListItemMeasure,
+  useListItemRegister,
 } from '@workday/canvas-kit-react/collection';
 
 import {useActionBarModel} from './useActionBarModel';
@@ -26,11 +25,7 @@ export interface ActionBarItemProps {
   'data-id'?: string;
 }
 
-export const useActionBarItem = composeHooks(
-  useOverflowListItemMeasure,
-  useListItemRovingFocus,
-  useListItemRegister
-);
+export const useActionBarItem = composeHooks(useOverflowListItemMeasure, useListItemRegister);
 
 export const ActionBarItem = createSubcomponent(SecondaryButton)({
   displayName: 'ActionBar.Item',

package/action-bar/lib/ActionBarList.tsx

@@ -4,18 +4,17 @@ import {commonColors, colors, space} from '@workday/canvas-kit-react/tokens';
 import {
   createSubcomponent,
   ExtractProps,
+  getTheme,
   styled,
   StyledType,
 } from '@workday/canvas-kit-react/common';
-import {HStack} from '@workday/canvas-kit-react/layout';
+import {Flex} from '@workday/canvas-kit-react/layout';
 import {useOverflowListMeasure, useListRenderItems} from '@workday/canvas-kit-react/collection';
 
 import {useActionBarModel} from './useActionBarModel';
-import {ActionBar} from './ActionBar';
 
-// Use `Partial` here to make `spacing` optional
-export interface ActionBarListProps<T = unknown>
-  extends Partial<ExtractProps<typeof HStack, never>> {
+export interface ActionBarListProps<T = any>
+  extends Omit<ExtractProps<typeof Flex, never>, 'children'> {
   /**
    * If items are passed to a `ActionBarModel`, the child of `ActionBar.List` should be a render prop. The
    * List will determine how and when the item will be rendered.
@@ -25,27 +24,41 @@ export interface ActionBarListProps<T = unknown>
    *   {(item) => <ActionBar.Item key={item.id} name={item.name}>{item.text}</ActionBar.Item>}
    * </ActionBar.List>
    */
-  children: ((item: T) => React.ReactNode) | React.ReactNode;
+  children: ((item: T, index: number) => React.ReactNode) | React.ReactNode;
+  /**
+   * `ActionBar.List` will render overflow button component if  it's passed in `overflowButton`.
+   *
+   * @example
+   * <ActionBar.List overflowButton={<ActionBar.OverflowButton aria-label="More actions" />}>
+   *   {(item) => <ActionBar.Item>{item.text}</ActionBar.Item>}
+   * </ActionBar.List>
+   */
+  overflowButton?: React.ReactNode;
 }
 
-const ResponsiveHStack = styled(HStack)<ActionBarListProps & StyledType>(({theme}) => ({
-  [theme.canvas.breakpoints.down('s')]: {
-    padding: space.s,
-    '> *': {
-      flex: 1,
+const ResponsiveList = styled(Flex)<ActionBarListProps & StyledType>(({theme}) => {
+  const {canvas: canvasTheme} = getTheme(theme);
+  return {
+    [canvasTheme.breakpoints.down('s')]: {
+      padding: space.s,
+      '> *': {
+        flex: 1,
+      },
     },
-  },
-}));
+  };
+});
+
+export const useActionBarList = useOverflowListMeasure;
 
 export const ActionBarList = createSubcomponent('div')({
   displayName: 'ActionBar.List',
   modelHook: useActionBarModel,
-  elemPropsHook: useOverflowListMeasure,
-})<ActionBarListProps>(({children, ...elemProps}, Element, model) => {
+  elemPropsHook: useActionBarList,
+})<ActionBarListProps>(({children, overflowButton, ...elemProps}, Element, model) => {
   return (
-    <ResponsiveHStack
+    <ResponsiveList
       as={Element}
-      spacing="s"
+      gap="s"
       depth={1}
       background={commonColors.background}
       borderTop={`solid 1px ${colors.soap400}`}
@@ -57,7 +70,7 @@ export const ActionBarList = createSubcomponent('div')({
       {...elemProps}
     >
       {useListRenderItems(model, children)}
-      <ActionBar.OverflowButton />
-    </ResponsiveHStack>
+      {overflowButton}
+    </ResponsiveList>
   );
 });

package/action-bar/lib/ActionBarOverflowButton.tsx

@@ -5,32 +5,36 @@ import {relatedActionsIcon} from '@workday/canvas-system-icons-web';
 import {
   createElemPropsHook,
   composeHooks,
-  subModelHook,
   createSubcomponent,
   StyledType,
+  createSubModelElemPropsHook,
 } from '@workday/canvas-kit-react/common';
 import {useOverflowListTarget} from '@workday/canvas-kit-react/collection';
 
 import {useMenuTarget} from '@workday/canvas-kit-react/menu';
 import {useActionBarModel} from './useActionBarModel';
-import {SecondaryButton} from '@workday/canvas-kit-react/button';
+import {SecondaryButton, SecondaryButtonProps} from '@workday/canvas-kit-react/button';
+
+export interface ActionBarOverflowButtonProps extends SecondaryButtonProps {
+  'aria-label': string;
+}
+
+const StyledSecondaryButton = styled(SecondaryButton)<StyledType>({
+  flex: 0,
+});
 
 export const useActionBarOverflowButton = composeHooks(
   createElemPropsHook(useActionBarModel)(() => ({
     'aria-haspopup': true,
   })),
   useOverflowListTarget,
-  subModelHook((m: ReturnType<typeof useActionBarModel>) => m.menu, useMenuTarget)
+  createSubModelElemPropsHook(useActionBarModel)(m => m.menu, useMenuTarget)
 );
 
-const StyledSecondaryButton = styled(SecondaryButton)<StyledType>({
-  flex: 0,
-});
-
 export const ActionBarOverflowButton = createSubcomponent('button')({
   displayName: 'ActionBar.OverflowButton',
   modelHook: useActionBarModel,
   elemPropsHook: useActionBarOverflowButton,
-})((elemProps, Element) => {
+})<ActionBarOverflowButtonProps>((elemProps, Element) => {
   return <StyledSecondaryButton as={Element} icon={relatedActionsIcon} {...elemProps} />;
 });

package/action-bar/lib/useActionBarModel.tsx

@@ -19,6 +19,12 @@ export const useActionBarModel = createModelHook({
      */
     orientation: 'horizontal' as typeof useOverflowListModel.defaultConfig.orientation,
     menuConfig: {} as Partial<typeof useMenuModel.defaultConfig>,
+    /**
+     * The maximum number of actions that can be visible.
+     * Must be greater than 1 and less than items.length.
+     * @default 3
+     */
+    maximumVisible: 3,
   },
   requiredConfig: useOverflowListModel.requiredConfig,
 })(config => {
@@ -38,9 +44,20 @@ export const useActionBarModel = createModelHook({
   let nonInteractiveIds = model.state.nonInteractiveIds;
   const totalSize = model.state.items.length;
 
-  // Only show a maximum of 3 buttons
-  if (totalSize - hiddenIds.length >= 3) {
-    hiddenIds = items.slice(3, totalSize).map(getId);
+  console.log(config.maximumVisible);
+
+  // Only show maximumVisible buttons
+  const maximumVisible: number =
+    !config.maximumVisible || config.maximumVisible < 1
+      ? 3 // should fallback to default value
+      : config.maximumVisible > totalSize
+      ? totalSize
+      : config.maximumVisible;
+
+  console.log('maximumVisible', maximumVisible);
+
+  if (totalSize - hiddenIds.length >= maximumVisible) {
+    hiddenIds = items.slice(maximumVisible, totalSize).map(getId);
   }
 
   // Always show the first button and make sure it is interactive

package/action-bar/package.json

@@ -1,5 +1,6 @@
 {
   "main": "../dist/commonjs/action-bar",
   "module": "../dist/es6/action-bar",
-  "sideEffects": false
+  "sideEffects": false,
+  "types": "../dist/es6/action-bar"
 }

package/avatar/index.ts

@@ -1,5 +1 @@
-import Avatar from './lib/Avatar';
-
-export default Avatar;
-export {Avatar};
 export * from './lib/Avatar';

package/avatar/lib/Avatar.tsx

@@ -119,7 +119,7 @@ const StyledImage = styled('img')<{isLoaded: boolean}>(
   })
 );
 
-const Avatar: AvatarOverload = React.forwardRef(
+export const Avatar: AvatarOverload = React.forwardRef(
   (
     {
       variant = AvatarVariant.Light,
@@ -174,5 +174,3 @@ const Avatar: AvatarOverload = React.forwardRef(
 
 Avatar.Variant = AvatarVariant;
 Avatar.Size = SystemIconCircleSize;
-
-export default Avatar;

package/avatar/package.json

@@ -1,5 +1,6 @@
 {
   "main": "../dist/commonjs/avatar",
   "module": "../dist/es6/avatar",
-  "sideEffects": false
+  "sideEffects": false,
+  "types": "../dist/es6/avatar"
 }

package/badge/index.ts

@@ -1 +1 @@
-export {default as CountBadge, CountBadgeProps} from './lib/CountBadge';
+export {CountBadge, CountBadgeProps} from './lib/CountBadge';

package/badge/lib/CountBadge.tsx

@@ -53,7 +53,7 @@ const Container = styled('span')<CountBadgeProps>(
   })
 );
 
-const CountBadge = (props: CountBadgeProps) => {
+export const CountBadge = (props: CountBadgeProps) => {
   const {variant = 'default', count = 0, limit = 1000, ...elemProps} = props;
 
   const formattedCount = count < limit ? `${count}` : `${limit - 1}+`;
@@ -64,5 +64,3 @@ const CountBadge = (props: CountBadgeProps) => {
     </Container>
   );
 };
-
-export default CountBadge;

package/badge/package.json

@@ -1,5 +1,6 @@
 {
   "main": "../dist/commonjs/badge",
   "module": "../dist/es6/badge",
-  "sideEffects": false
+  "sideEffects": false,
+  "types": "../dist/es6/badge"
 }

package/banner/lib/Banner.tsx

@@ -26,14 +26,8 @@ export interface BannerProps extends ExtractProps<typeof Flex, never> {
   children?: React.ReactNode;
 }
 
-// Remove color from our type since it is set on the Flex style attribute
-const {color: _color, ...typeLevelsSubtextLarge} = type.levels.subtext.large;
-
 const styles: CSSProperties = {
-  ...typeLevelsSubtextLarge,
   cursor: 'pointer',
-  fontWeight: type.properties.fontWeights.medium,
-  textAlign: 'left',
   transition: 'background-color 120ms',
   '&:focus': {
     outline: 'none',
@@ -42,13 +36,69 @@ const styles: CSSProperties = {
   ...hideMouseFocus,
 };
 
+/**
+ * `Banner` is a container component rendered as a `<button>` element that is responsible for creating
+ * a `BannerModel` and sharing it with its subcomponents using React context.
+ *
+ * ```tsx
+ * <Banner
+ * 	isSticky={true}
+ * 	hasError={true}
+ * 	id='custom-banner-id'
+ * 	onClick={() => console.log('clicked banner')}
+ * >
+ *   {Child components}
+ * </Banner>
+ * ```
+ *
+ * Alternatively, you may pass in a model using the hoisted model pattern.
+ *
+ * ```tsx
+ * const model = useBannerModel({
+ *   isSticky: true,
+ *   hasError: true,
+ *   id: 'custom-banner-id',
+ * });
+ *
+ * return (
+ *   <Banner onClick={() => console.log('clicked banner')} model={model}>
+ *     {Child components}
+ *   </Banner>
+ * );
+ * ```
+ */
 export const Banner = createContainer('button')({
   displayName: 'Banner',
   modelHook: useBannerModel,
   elemPropsHook: useBanner,
   subComponents: {
+    /**
+     * `Banner.Icon` is a styled {@link SystemIcon}. The icon defaults to exclamationTriangleIcon or
+     * exclamationCircleIcon when the model's hasError is true.
+     *
+     * ```tsx
+     * <Banner.Icon />
+     * ```
+     */
     Icon: BannerIcon,
+    /**
+     * `Banner.Label` is a styled {@link Flex}. This component will get an id that will be used for
+     * the aria-describedby on the top level `<button>`.
+     *
+     * ```tsx
+     * <Banner.Label>3 Warnings</Banner.Label>
+     * ```
+     */
     Label: BannerLabel,
+    /**
+     * `Banner.ActionText` is a styled {@link Box}. This component will get an id that will be used
+     * for the aria-labelledby on the top level `<button>`. This component will be visually hidden
+     * when the model's `isSticky` prop is set to true.
+     *
+     * ```tsx
+     * <Banner.ActionText>Custom call to action</Banner.ActionText>
+     * ```
+     */
     ActionText: BannerActionText,
   },
 })<BannerProps>(({children, ...elemProps}, Element, model) => {
@@ -75,6 +125,9 @@ export const Banner = createContainer('button')({
   return (
     <Flex
       as={Element}
+      {...type.levels.subtext.large}
+      fontWeight="medium"
+      textAlign="left"
       width={model.state.isSticky ? '222px' : '328px'}
       backgroundColor={palette.normal}
       color={palette.contrast}

package/banner/lib/BannerIcon.tsx

@@ -14,7 +14,6 @@ import {useBannerIcon, useBannerModel} from './hooks';
 export interface BannerIconProps extends Omit<ExtractProps<typeof SystemIcon, never>, 'icon'> {
   /**
    * Icon to show next to label
-   * @default exclamationTriangleIcon or exclamationCircleIcon when hasError is true
    */
   icon?: CanvasSystemIcon;
 }

package/banner/lib/hooks/index.ts

@@ -1,6 +1,8 @@
+import {getPaletteColors} from './useThemedPalette';
 export * from './useBannerModel';
 export * from './useThemedPalette';
 export * from './useBannerIcon';
 export * from './useBannerLabel';
 export * from './useBannerActionText';
 export * from './useBanner';
+export {getPaletteColors};

package/banner/lib/hooks/useThemedPalette.ts

@@ -27,10 +27,10 @@ const getPaletteColorsFromTheme = (
   };
 };
 
-export function getPaletteColors(
+export const getPaletteColors = (
   type: paletteSelection,
   theme: EmotionCanvasTheme
-): BackgroundColors {
+): BackgroundColors => {
   const palette = theme.canvas.palette[type];
 
   switch (type) {
@@ -44,7 +44,7 @@ export function getPaletteColors(
       return getPaletteColorsFromTheme(palette);
     }
   }
-}
+};
 
 export const useThemedPalette = (type: paletteSelection) => {
   const theme = useTheme();

package/banner/package.json

@@ -1,5 +1,6 @@
 {
   "main": "../dist/commonjs/banner",
   "module": "../dist/es6/banner",
-  "sideEffects": false
+  "sideEffects": false,
+  "types": "../dist/es6/banner"
 }

package/breadcrumbs/LICENSE

@@ -0,0 +1,52 @@
+Apache License, Version 2.0 Apache License Version 2.0, January 2004
+
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License.
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions.
+Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks.
+This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability.
+In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+©2021 Workday, Inc. All rights reserved. Workday and the Workday logo are registered trademarks of Workday, Inc. All other brand and product names are trademarks or registered trademarks of their respective holders.
+
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

package/breadcrumbs/README.md

@@ -0,0 +1,9 @@
+# Canvas Kit React Breadcrumbs
+
+Breadcrumbs is a
+[compound component](/getting-started/for-developers/resources/compound-components/) that allows
+users to keep track and maintain awareness of their location as they navigate through pages,
+folders, files, etc.
+
+For more detailed information on this component, please refer to the
+[storybook documentation](https://workday.github.io/canvas-kit/?path=/docs/components-navigation-breadcrumbs-react--basic)

package/breadcrumbs/index.ts

@@ -0,0 +1,2 @@
+export * from './lib/Breadcrumbs';
+export * from './lib/hooks/useBreadcrumbsModel';