@workday/canvas-kit-docs 15.0.0-alpha.0076-next.0 → 15.0.0-alpha.0090-next.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workday/canvas-kit-docs",
-  "version": "15.0.0-alpha.0076-next.0",
+  "version": "15.0.0-alpha.0090-next.0",
   "description": "Documentation components of Canvas Kit components",
   "author": "Workday, Inc. (https://www.workday.com)",
   "license": "Apache-2.0",
@@ -45,10 +45,10 @@
     "@emotion/styled": "^11.6.0",
     "@stackblitz/sdk": "^1.11.0",
     "@storybook/csf": "0.0.1",
-    "@workday/canvas-kit-labs-react": "^15.0.0-alpha.0076-next.0",
-    "@workday/canvas-kit-preview-react": "^15.0.0-alpha.0076-next.0",
-    "@workday/canvas-kit-react": "^15.0.0-alpha.0076-next.0",
-    "@workday/canvas-kit-styling": "^15.0.0-alpha.0076-next.0",
+    "@workday/canvas-kit-labs-react": "^15.0.0-alpha.0090-next.0",
+    "@workday/canvas-kit-preview-react": "^15.0.0-alpha.0090-next.0",
+    "@workday/canvas-kit-react": "^15.0.0-alpha.0090-next.0",
+    "@workday/canvas-kit-styling": "^15.0.0-alpha.0090-next.0",
     "@workday/canvas-system-icons-web": "^3.0.36",
     "@workday/canvas-tokens-web": "4.0.0-alpha.3",
     "markdown-to-jsx": "^7.2.0",
@@ -61,5 +61,5 @@
     "mkdirp": "^1.0.3",
     "typescript": "5.0"
   },
-  "gitHead": "5d389f1b5a66cf5bde37eb570ff634a7b143ee98"
+  "gitHead": "54d08f77d0527af840c9f102ce9a8f44942a5e9d"
 }

package/dist/mdx/preview-react/avatar/examples/Basic.tsx

@@ -1,5 +0,0 @@
-import {Avatar} from '@workday/canvas-kit-preview-react/avatar';
-
-export default () => {
-  return <Avatar name="John Doe" />;
-};

package/dist/mdx/react/avatar/avatar/Avatar.mdx

@@ -1,109 +0,0 @@
-import {
-  Specifications,
-  SymbolDoc,
-  SymbolDescription,
-  ExampleCodeBlock,
-  StorybookStatusIndicator,
-} from '@workday/canvas-kit-docs';
-import {InformationHighlight} from '@workday/canvas-kit-react/information-highlight';
-
-import Basic from './examples/Basic';
-import Button from './examples/Button';
-import Image from './examples/Image';
-import LazyLoad from './examples/LazyLoad';
-import ObjectFit from './examples/ObjectFit';
-import Size from './examples/Size';
-import Variant from './examples/Variant';
-import CustomStyles from './examples/CustomStyles';
-
-
-# Canvas Kit Avatar <StorybookStatusIndicator type="deprecated" />
-
-<InformationHighlight className="sb-unstyled" variant="caution" cs={{p: {marginBlock: 0}}}>
-  <InformationHighlight.Icon />
-  <InformationHighlight.Body>
-    `Avatar` in Main has been deprecated and will be removed in a future major version. Please use
-    [Avatar](https://workday.github.io/canvas-kit/?path=/docs/preview-avatar--docs) in Preview
-    instead.
-  </InformationHighlight.Body>
-</InformationHighlight>
-
-Represents a person's profile.
-
-[> Workday Design Reference](https://canvas.workdaydesign.com/components/indicators/avatar)
-
-## Installation
-
-```sh
-yarn add @workday/canvas-kit-react
-```
-
-## Usage
-
-<SymbolDescription name="Avatar" fileName="/react/" />
-
-The example below shows multiple instances of a `Avatar` with various configurations.
-
-### Basic
-
-By default, the Avatar renders a `button` element. If yo'd like to change the default element, use
-the `as` prop.
-
-<ExampleCodeBlock code={Basic} />
-
-### Button
-
-Like many of our components, Avatar accepts an `as` prop, which lets you change the underlying
-semantic element to a `div`. This should be done with caution to ensure the best accessibility.
-Generally, `<button>` elements should be used for actions.
-
-<ExampleCodeBlock code={Button} />
-
-### Variant
-
-Avatar defaults to using a `"light"` `variant` property. You can change the `variant` prop to "dark"
-by including `variant="dark"`.
-
-<ExampleCodeBlock code={Variant} />
-
-### Size
-
-Avatar defaults to using a `"medium"` `size` property. You can change the `size` prop to various
-sizing options. See Component API for more details.
-
-Additionally, you can explicitly specify the size you want for the Avatar in pixels or rems.
-
-<ExampleCodeBlock code={Size} />
-
-### Image
-
-Avatar renders an image when the `url` prop is defined.
-
-<ExampleCodeBlock code={Image} />
-
-### Object Fit
-
-Avatar defaults to using `contain` for object-fit. You can change this property to any other
-acceptable `object-fit` properties. For best fit, try to use square images.
-
-<ExampleCodeBlock code={ObjectFit} />
-
-### Lazy Load
-
-Example of implementing lazy load behavior with Avatar.
-
-<ExampleCodeBlock code={LazyLoad} />
-
-### Custom Styling
-
-To change the background color of the Avatar, you can use our `createStencil` functionality.
-
-<ExampleCodeBlock code={CustomStyles} />
-
-## Component API
-
-<SymbolDoc name="Avatar" fileName="/react/" />
-
-## Specifications
-
-<Specifications file="Avatar.spec.ts" name="Avatar" />

package/dist/mdx/react/avatar/avatar/examples/Basic.tsx

@@ -1,17 +0,0 @@
-import {Avatar} from '@workday/canvas-kit-react/avatar';
-import {createStyles} from '@workday/canvas-kit-styling';
-import {system} from '@workday/canvas-tokens-web';
-
-const handleAvatarButtonClick = () => console.log('AvatarButton clicked');
-
-const containerStyles = createStyles({
-  display: 'inline-flex',
-  gap: system.space.x2,
-});
-
-export default () => (
-  <div className={containerStyles}>
-    <Avatar altText="Avatar" onClick={handleAvatarButtonClick} />
-    <Avatar altText="Avatar" as="div" />
-  </div>
-);

package/dist/mdx/react/avatar/avatar/examples/Button.tsx

@@ -1,20 +0,0 @@
-import {Avatar} from '@workday/canvas-kit-react/avatar';
-import {createStyles} from '@workday/canvas-kit-styling';
-import {system} from '@workday/canvas-tokens-web';
-// @ts-ignore: Cannot find module error
-import testAvatar from './test-avatar.png';
-
-const handleAvatarButtonClick = () => console.log('AvatarButton clicked');
-
-const containerStyles = createStyles({
-  display: 'inline-flex',
-  gap: system.space.x2,
-});
-
-export default () => (
-  <div className={containerStyles}>
-    <Avatar altText="Avatar" variant="dark" onClick={handleAvatarButtonClick} />
-    <Avatar altText="Avatar" onClick={handleAvatarButtonClick} />
-    <Avatar altText="Avatar" url={testAvatar} onClick={handleAvatarButtonClick} />
-  </div>
-);

package/dist/mdx/react/avatar/avatar/examples/CustomStyles.tsx

@@ -1,34 +0,0 @@
-import {Avatar} from '@workday/canvas-kit-react/avatar';
-import {createStencil, createStyles} from '@workday/canvas-kit-styling';
-import {system} from '@workday/canvas-tokens-web';
-import {systemIconStencil} from '@workday/canvas-kit-react/icon';
-
-const customOrangeAvatar = createStencil({
-  base: {
-    backgroundColor: system.color.static.amber.default,
-    ['[data-part="avatar-icon"]']: {
-      [systemIconStencil.vars.color]: system.color.static.white,
-    },
-  },
-});
-
-const customGreenAvatarStencil = createStencil({
-  base: {
-    backgroundColor: system.color.static.green.default,
-    ['[data-part="avatar-icon"]']: {
-      [systemIconStencil.vars.color]: system.color.static.white,
-    },
-  },
-});
-
-const containerStyles = createStyles({
-  display: 'inline-flex',
-  gap: system.space.x2,
-});
-
-export default () => (
-  <div className={containerStyles}>
-    <Avatar altText="Avatar" as="div" {...customOrangeAvatar()} />
-    <Avatar altText="Avatar" as="div" {...customGreenAvatarStencil()} />
-  </div>
-);

package/dist/mdx/react/avatar/avatar/examples/Image.tsx

@@ -1,25 +0,0 @@
-import {Avatar} from '@workday/canvas-kit-react/avatar';
-// @ts-ignore: Cannot find module error
-import testAvatar from './test-avatar.png';
-import {createStyles} from '@workday/canvas-kit-styling';
-import {system} from '@workday/canvas-tokens-web';
-
-const containerStyles = createStyles({
-  display: 'flex',
-  flexDirection: 'column',
-  gap: system.space.x2,
-});
-
-export default () => (
-  <div className={containerStyles}>
-    <h3>Working Images</h3>
-    <Avatar altText="Avatar" size="extraExtraLarge" as="div" url={testAvatar} />
-    <Avatar altText="Avatar" size="extraLarge" as="div" url={testAvatar} />
-    <Avatar altText="Avatar" size="large" as="div" url={testAvatar} />
-    <Avatar altText="Avatar" size="medium" as="div" url={testAvatar} />
-    <Avatar altText="Avatar" size="small" as="div" url={testAvatar} />
-    <Avatar altText="Avatar" size="extraSmall" as="div" url={testAvatar} />
-    <h3>Broken Image</h3>
-    <Avatar altText="Avatar" url="/fake/path/to/image.png" as="div" />
-  </div>
-);

package/dist/mdx/react/avatar/avatar/examples/LazyLoad.tsx

@@ -1,20 +0,0 @@
-import {Avatar} from '@workday/canvas-kit-react/avatar';
-// @ts-ignore: Cannot find module error
-import testAvatar from './test-avatar.png';
-
-export default () => (
-  <div className="story">
-    {Array.from({length: 5}, (v, index) => (
-      <div>
-        <Avatar
-          altText="Avatar"
-          key={index}
-          as="div"
-          size="medium"
-          url={testAvatar + '?v=' + index}
-        />
-        <br />
-      </div>
-    ))}
-  </div>
-);

package/dist/mdx/react/avatar/avatar/examples/ObjectFit.tsx

@@ -1,30 +0,0 @@
-import {Avatar} from '@workday/canvas-kit-react/avatar';
-import {px2rem} from '@workday/canvas-kit-styling';
-
-export default () => (
-  <div className="story">
-    <h3>Original Rectangle Image</h3>
-    <img alt="" src="https://picsum.photos/id/237/300/200" />
-    <h3>Object fit on a Rectangle Image</h3>
-    <Avatar altText="Avatar" as="div" url="https://picsum.photos/id/237/300/200" />
-    <h3>Object fit on a Rectangle Image using Dynamic Size</h3>
-    <Avatar
-      altText="Avatar"
-      as="div"
-      size={px2rem(200)}
-      url="https://picsum.photos/id/237/300/200"
-      objectFit="contain"
-    />
-    <h3>Original Square Image</h3>
-    <img alt="" src="https://picsum.photos/id/237/300/300" />
-    <h3>Object fit on a Square Image</h3>
-    <Avatar altText="Avatar" as="div" url="https://picsum.photos/id/237/300/300" />
-    <h3>Object fit on a Square Image using Dynamic Size</h3>
-    <Avatar
-      altText="Avatar"
-      as="div"
-      size={px2rem(200)}
-      url="https://picsum.photos/id/237/300/300"
-    />
-  </div>
-);

package/dist/mdx/react/avatar/avatar/examples/Size.tsx

@@ -1,27 +0,0 @@
-import {Avatar} from '@workday/canvas-kit-react/avatar';
-import {px2rem} from '@workday/canvas-kit-styling';
-
-export default () => (
-  <div className="story">
-    <h3>Extra-Extra Large</h3>
-    <Avatar altText="Avatar" as="div" size="extraExtraLarge" />
-    <h3>Extra Large</h3>
-    <Avatar altText="Avatar" as="div" size="extraLarge" />
-    <h3>Large</h3>
-    <Avatar altText="Avatar" as="div" size="large" />
-    <h3>Medium</h3>
-    <Avatar altText="Avatar" as="div" size="medium" />
-    <h3>Small</h3>
-    <Avatar altText="Avatar" as="div" size="small" />
-    <h3>Extra Small</h3>
-    <Avatar altText="Avatar" as="div" size="extraSmall" />
-    <h3>30px</h3>
-    <Avatar altText="Avatar" as="div" size={px2rem(30)} />
-    <h3>40px</h3>
-    <Avatar altText="Avatar" as="div" size={px2rem(40)} />
-    <h3>3rem</h3>
-    <Avatar altText="Avatar" as="div" size="3rem" />
-    <h3>4rem</h3>
-    <Avatar altText="Avatar" as="div" size="4rem" />
-  </div>
-);

package/dist/mdx/react/avatar/avatar/examples/Variant.tsx

@@ -1,10 +0,0 @@
-import {Avatar} from '@workday/canvas-kit-react/avatar';
-
-export default () => (
-  <div className="story">
-    <h3>Light</h3>
-    <Avatar altText="Avatar" as="div" size="medium" />
-    <h3>Dark</h3>
-    <Avatar altText="Avatar" as="div" size="medium" variant="dark" />
-  </div>
-);