@workday/canvas-kit-react 15.0.0-alpha.1283-next.0 → 15.0.0-alpha.1287-next.0

package/layout/lib/utils/layout.ts

@@ -3,52 +3,73 @@ import {Property} from 'csstype';
 import {buildStyleFns, buildStylePropFn, StyleFnConfig} from './buildStyleFns';
 import {SystemPropValues} from './systemProps';
 
-/** style props to for CSS layout properties */
+/** style props to for CSS layout properties
+ * @deprecated ⚠️ Style props are deprecated. Please use our `cs` prop with `createStencil` or `createStyles` to apply styles. For more information view our [Styling docs](* @deprecated ⚠️ `boxStyleFn` is deprecated and will be removed in a future major version. Please reference our new way of styling components [here](https://workday.github.io/canvas-kit/?path=/docs/styling-getting-started-overview--docs).
+ */
 export type LayoutStyleProps = {
-  /** sets [CSS display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display) */
+  /** sets [CSS display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display)
+   * @deprecated
+   */
   display?: Property.Display;
   /**
    * - sets [CSS height property](https://developer.mozilla.org/en-US/docs/Web/CSS/height)
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   height?: SystemPropValues['space'];
-  /** sets [CSS list-style property](https://developer.mozilla.org/en-US/docs/Web/CSS/list-style) */
+  /** sets [CSS list-style property](https://developer.mozilla.org/en-US/docs/Web/CSS/list-style)
+   * @deprecated
+   */
   listStyle?: Property.ListStyle;
   /**
    * - sets [CSS max-height property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-height)
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   maxHeight?: SystemPropValues['space'];
   /**
    * - sets [CSS max-width property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-width)
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   maxWidth?: SystemPropValues['space'];
   /**
    * - sets [CSS min-height property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-height)
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   minHeight?: SystemPropValues['space'];
   /**
    * - sets [CSS min-width property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-width)
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   minWidth?: SystemPropValues['space'];
-  /** sets [CSS overflow property](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow) */
+  /** sets [CSS overflow property](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow)
+   * @deprecated
+   */
   overflow?: Property.Overflow;
-  /** sets [CSS overflow-x property](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow-x) */
+  /** sets [CSS overflow-x property](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow-x)
+   * @deprecated
+   */
   overflowX?: Property.OverflowX;
-  /** sets [CSS overflow-y property](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow-y) */
+  /** sets [CSS overflow-y property](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow-y)
+   * @deprecated
+   */
   overflowY?: Property.OverflowY;
-  /** sets [CSS vertical-align property](https://developer.mozilla.org/en-US/docs/Web/CSS/vertical-align) */
+  /** sets [CSS vertical-align property](https://developer.mozilla.org/en-US/docs/Web/CSS/vertical-align)
+   * @deprecated
+   */
   verticalAlign?: Property.VerticalAlign;
   /**
    * - sets [CSS width property](https://developer.mozilla.org/en-US/docs/Web/CSS/width)
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   width?: SystemPropValues['space'];
 };
 
+/** @deprecated */
 export const layoutStyleFnConfigs: StyleFnConfig[] = [
   {
     name: 'display',
@@ -112,6 +133,7 @@ export const layoutStyleFnConfigs: StyleFnConfig[] = [
   },
 ];
 
+/** @deprecated */
 export const layoutStyleFns = buildStyleFns(layoutStyleFnConfigs);
 /**
  * A style prop function that takes component props and returns layout styles.
@@ -125,5 +147,6 @@ export const layoutStyleFns = buildStyleFns(layoutStyleFnConfigs);
  *   </Box>
  * );
  * ```
+ * @deprecated
  */
 export const layout = buildStylePropFn<LayoutStyleProps>(layoutStyleFns);

package/layout/lib/utils/mergeStyles.ts

@@ -43,6 +43,7 @@ function isStyleProps(prop: string): boolean {
 /**
  * This function has the same signature as {@link handleCsProp} and also calls `handleCsProps`, but
  * adds support for style props. It can be used as a drop-in replacement for `handleCsProps`.
+ * @deprecated ⚠️ `mergeStyles` is deprecated since it supports style props. Use `handleCsProps` to ensure correct style merging order. For more information view our [docs](https://workday.github.io/canvas-kit/?path=/docs/styling-guides-merging-styles--docs#handlecsprop).
  */
 export function mergeStyles<T extends {}>(
   /**

package/layout/lib/utils/other.ts

@@ -2,76 +2,146 @@ import {Property} from 'csstype';
 
 import {buildStyleFns, buildStylePropFn, StyleFnConfig} from './buildStyleFns';
 
-/** style props to for other CSS properties */
+/**
+ * style props to for other CSS properties
+ * @deprecated ⚠️ Style props are deprecated. Please use our `cs` prop with `createStencil` or `createStyles` to apply styles. For more information view our [Styling docs](* @deprecated ⚠️ `boxStyleFn` is deprecated and will be removed in a future major version. Please reference our new way of styling components [here](https://workday.github.io/canvas-kit/?path=/docs/styling-getting-started-overview--docs).
+ */
 export type OtherStyleProps = {
-  /** sets [CSS animation property](https://developer.mozilla.org/en-US/docs/Web/CSS/animation) */
+  /** sets [CSS animation property](https://developer.mozilla.org/en-US/docs/Web/CSS/animation)
+   * @deprecated
+   */
   animation?: Property.Animation;
-  /** sets [CSS appearance property](https://developer.mozilla.org/en-US/docs/Web/CSS/appearance) */
+  /** sets [CSS appearance property](https://developer.mozilla.org/en-US/docs/Web/CSS/appearance)
+   * @deprecated
+   */
   appearance?: Property.Appearance;
-  /** sets [CSS box-sizing property](https://developer.mozilla.org/en-US/docs/Web/CSS/box-sizing) */
+  /** sets [CSS box-sizing property](https://developer.mozilla.org/en-US/docs/Web/CSS/box-sizing)
+   * @deprecated
+   */
   boxSizing?: Property.BoxSizing;
-  /** sets [CSS content property](https://developer.mozilla.org/en-US/docs/Web/CSS/content) */
+  /** sets [CSS content property](https://developer.mozilla.org/en-US/docs/Web/CSS/content)
+   * @deprecated
+   */
   content?: Property.Content;
-  /** sets [CSS cursor property](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) */
+  /** sets [CSS cursor property](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor)
+   * @deprecated
+   */
   cursor?: Property.Cursor;
-  /** sets [CSS fill property](https://developer.mozilla.org/en-US/docs/Web/CSS/fill) */
+  /** sets [CSS fill property](https://developer.mozilla.org/en-US/docs/Web/CSS/fill)
+   * @deprecated
+   */
   fill?: Property.Fill;
-  /** sets [CSS float property](https://developer.mozilla.org/en-US/docs/Web/CSS/float) */
+  /** sets [CSS float property](https://developer.mozilla.org/en-US/docs/Web/CSS/float)
+   * @deprecated
+   */
   float?: Property.Float;
-  /** sets [CSS object-fit property](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit) */
+  /** sets [CSS object-fit property](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit)
+   * @deprecated
+   */
   objectFit?: Property.ObjectFit;
-  /** sets [CSS object-position property](https://developer.mozilla.org/en-US/docs/Web/CSS/object-position) */
+  /** sets [CSS object-position property](https://developer.mozilla.org/en-US/docs/Web/CSS/object-position)
+   * @deprecated
+   */
   objectPosition?: Property.ObjectPosition;
-  /** sets [CSS opacity](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) */
+  /** sets [CSS opacity](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity)
+   * @deprecated
+   */
   opacity?: Property.Opacity;
-  /** sets [CSS outline property](https://developer.mozilla.org/en-US/docs/Web/CSS/outline) */
+  /** sets [CSS outline property](https://developer.mozilla.org/en-US/docs/Web/CSS/outline)
+   * @deprecated
+   */
   outline?: Property.Outline;
-  /** sets [CSS outline-offset property](https://developer.mozilla.org/en-US/docs/Web/CSS/outline-offset) */
+  /** sets [CSS outline-offset property](https://developer.mozilla.org/en-US/docs/Web/CSS/outline-offset)
+   * @deprecated
+   */
   outlineOffset?: Property.OutlineOffset;
-  /** sets [CSS overflow-wrap property](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow-wrap) */
+  /** sets [CSS overflow-wrap property](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow-wrap)
+   * @deprecated
+   */
   overflowWrap?: Property.OverflowWrap;
-  /** sets [CSS pointer-events property](https://developer.mozilla.org/en-US/docs/Web/CSS/pointer-events) */
+  /** sets [CSS pointer-events property](https://developer.mozilla.org/en-US/docs/Web/CSS/pointer-events)
+   * @deprecated
+   */
   pointerEvents?: Property.PointerEvents;
-  /** sets [CSS resize property](https://developer.mozilla.org/en-US/docs/Web/CSS/resize) */
+  /** sets [CSS resize property](https://developer.mozilla.org/en-US/docs/Web/CSS/resize)
+   * @deprecated
+   */
   resize?: Property.Resize;
-  /** sets [CSS scroll margin property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-margin) */
+  /** sets [CSS scroll margin property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-margin)
+   * @deprecated
+   */
   scrollMargin?: Property.ScrollMargin;
-  /** sets [CSS scroll margin bottom property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-margin-bottom) */
+  /** sets [CSS scroll margin bottom property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-margin-bottom)
+   * @deprecated
+   */
   scrollMarginBottom?: Property.ScrollMarginBottom;
-  /** sets [CSS scroll margin top property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-margin-top) */
+  /** sets [CSS scroll margin top property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-margin-top)
+   * @deprecated
+   */
   scrollMarginTop?: Property.ScrollMarginTop;
-  /** sets [CSS scroll margin inline start property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-margin-inline-start) */
+  /** sets [CSS scroll margin inline start property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-margin-inline-start)
+   * @deprecated
+   */
   scrollMarginInlineStart?: Property.ScrollMarginInlineStart;
-  /** sets [CSS scroll margin inline end property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-margin-inline-end) */
+  /** sets [CSS scroll margin inline end property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-margin-inline-end)
+   * @deprecated
+   */
   scrollMarginInlineEnd?: Property.ScrollMarginInlineEnd;
-  /** sets [CSS scroll padding property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-padding) */
+  /** sets [CSS scroll padding property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-padding)
+   * @deprecated
+   */
   scrollPadding?: Property.ScrollPadding;
-  /** sets [CSS scroll padding bottom property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-padding-bottom) */
+  /** sets [CSS scroll padding bottom property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-padding-bottom)
+   * @deprecated
+   */
   scrollPaddingBottom?: Property.ScrollPaddingBottom;
-  /** sets [CSS scroll padding top property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-padding-top) */
+  /** sets [CSS scroll padding top property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-padding-top)
+   * @deprecated
+   */
   scrollPaddingTop?: Property.ScrollPaddingTop;
-  /** sets [CSS scroll padding inline start property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-padding-inline-start) */
+  /** sets [CSS scroll padding inline start property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-padding-inline-start)
+   * @deprecated
+   */
   scrollPaddingInlineStart?: Property.ScrollPaddingInlineStart;
-  /** sets [CSS scroll padding inline end property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-padding-inline-end) */
+  /** sets [CSS scroll padding inline end property](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-padding-inline-end)
+   * @deprecated
+   */
   scrollPaddingInlineEnd?: Property.ScrollPaddingInlineEnd;
-  /** sets [CSS scroll snap align property](https://developer.mozilla.org/docs/Web/CSS/scroll-snap-align) */
+  /** sets [CSS scroll snap align property](https://developer.mozilla.org/docs/Web/CSS/scroll-snap-align)
+   * @deprecated
+   */
   scrollSnapAlign?: Property.ScrollSnapAlign;
-  /** sets [CSS scroll snap stop property](https://developer.mozilla.org/docs/Web/CSS/scroll-snap-stop) */
+  /** sets [CSS scroll snap stop property](https://developer.mozilla.org/docs/Web/CSS/scroll-snap-stop)
+   * @deprecated
+   */
   scrollSnapStop?: Property.ScrollSnapStop;
-  /** sets [CSS scroll snap type property](https://developer.mozilla.org/docs/Web/CSS/scroll-snap-type) */
+  /** sets [CSS scroll snap type property](https://developer.mozilla.org/docs/Web/CSS/scroll-snap-type)
+   * @deprecated
+   */
   scrollSnapType?: Property.ScrollSnapType;
-  /** sets [CSS stroke property](https://developer.mozilla.org/en-US/docs/Web/CSS/stroke) */
+  /** sets [CSS stroke property](https://developer.mozilla.org/en-US/docs/Web/CSS/stroke)
+   * @deprecated
+   */
   stroke?: Property.Stroke;
-  /** sets [CSS transform property](https://developer.mozilla.org/en-US/docs/Web/CSS/transform) */
+  /** sets [CSS transform property](https://developer.mozilla.org/en-US/docs/Web/CSS/transform)
+   * @deprecated
+   */
   transform?: Property.Transform;
-  /** sets [CSS transition property](https://developer.mozilla.org/en-US/docs/Web/CSS/transition) */
+  /** sets [CSS transition property](https://developer.mozilla.org/en-US/docs/Web/CSS/transition)
+   * @deprecated
+   */
   transition?: Property.Transition;
-  /** sets [CSS user-select property](https://developer.mozilla.org/en-US/docs/Web/CSS/user-select) */
+  /** sets [CSS user-select property](https://developer.mozilla.org/en-US/docs/Web/CSS/user-select)
+   * @deprecated
+   */
   userSelect?: Property.UserSelect;
-  /** sets [CSS visibility property](https://developer.mozilla.org/en-US/docs/Web/CSS/visibility) */
+  /** sets [CSS visibility property](https://developer.mozilla.org/en-US/docs/Web/CSS/visibility)
+   * @deprecated
+   */
   visibility?: Property.Visibility;
 };
 
+/** @deprecated */
 export const otherStyleFnConfigs: StyleFnConfig[] = [
   {
     name: 'animation',
@@ -170,6 +240,8 @@ export const otherStyleFnConfigs: StyleFnConfig[] = [
   },
 ];
 
+/** @deprecated */
 export const otherStyleFns = buildStyleFns(otherStyleFnConfigs);
 
+/** @deprecated */
 export const other = buildStylePropFn<OtherStyleProps>(otherStyleFns);

package/layout/lib/utils/position.ts

@@ -2,50 +2,63 @@ import {Property} from 'csstype';
 
 import {buildStyleFns, buildStylePropFn, StyleFnConfig} from './buildStyleFns';
 
-/** style props to for CSS position properties */
+/**
+ * style props to for CSS position properties
+ * @deprecated ⚠️ Style props are deprecated. Please use our `cs` prop with `createStencil` or `createStyles` to apply styles. For more information view our [Styling docs](* @deprecated ⚠️ `boxStyleFn` is deprecated and will be removed in a future major version. Please reference our new way of styling components [here](https://workday.github.io/canvas-kit/?path=/docs/styling-getting-started-overview--docs).
+ */
 export type PositionStyleProps = {
   /**
    * - sets [CSS position property](https://developer.mozilla.org/en-US/docs/Web/CSS/position)
-   * */
+   * @deprecated
+   */
   position?: Property.Position;
   /**
    * - sets [CSS z-index property](https://developer.mozilla.org/en-US/docs/Web/CSS/z-index)
-   * */
+   * @deprecated
+   */
   zIndex?: Property.ZIndex;
   /**
    * - sets [CSS top property](https://developer.mozilla.org/en-US/docs/Web/CSS/top)
-   * */
+   * @deprecated
+   */
   top?: number | string;
   /**
    * - sets [CSS right property](https://developer.mozilla.org/en-US/docs/Web/CSS/right)
    * - no bidirectional support
-   * */
+   * @deprecated
+   */
   right?: number | string;
   /**
    * - sets [CSS bottom property](https://developer.mozilla.org/en-US/docs/Web/CSS/bottom)
-   * */
+   * @deprecated
+   */
   bottom?: number | string;
   /**
    * - sets [CSS left property](https://developer.mozilla.org/en-US/docs/Web/CSS/left)
    * - no bidirectional support
-   * */
+   * @deprecated
+   */
   left?: number | string;
   /**
    * - sets [CSS inset property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset)
+   * @deprecated
    */
   inset?: number | string;
   /**
    * - sets [CSS inset-inline-start property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset-inline-start)
    * - bidirectional support
-   * */
+   * @deprecated
+   */
   insetInlineStart?: number | string;
   /**
    * - sets [CSS inset-inline-end property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset-inline-end)
    * - bidirectional support
-   * */
+   * @deprecated
+   */
   insetInlineEnd?: number | string;
 };
 
+/** @deprecated */
 export const positionStyleFnConfigs: StyleFnConfig[] = [
   {
     name: 'position',
@@ -94,6 +107,7 @@ export const positionStyleFnConfigs: StyleFnConfig[] = [
   },
 ];
 
+/** @deprecated */
 export const positionStyleFns = buildStyleFns(positionStyleFnConfigs);
 /**
  * A style prop function that takes component props and returns position styles.
@@ -107,5 +121,6 @@ export const positionStyleFns = buildStyleFns(positionStyleFnConfigs);
  *   </Box>
  * );
  * ```
+ * @deprecated
  */
 export const position = buildStylePropFn<PositionStyleProps>(positionStyleFns);

package/layout/lib/utils/space.ts

@@ -1,108 +1,129 @@
 import {buildStyleFns, buildStylePropFn, StyleFnConfig} from './buildStyleFns';
 import {SystemPropValues} from './systemProps';
 
-/** style props to for CSS space properties */
+/** style props to for CSS space properties
+ * @deprecated ⚠️ Style props are deprecated. Please use our `cs` prop with `createStencil` or `createStyles` to apply styles. For more information view our [Styling docs](* @deprecated ⚠️ `boxStyleFn` is deprecated and will be removed in a future major version. Please reference our new way of styling components [here](https://workday.github.io/canvas-kit/?path=/docs/styling-getting-started-overview--docs).
+ */
 export type SpaceStyleProps = {
   /**
    * - sets [CSS margin-inline-start property](https://developer.mozilla.org/en-US/docs/Web/CSS/margin-inline-start)
    * - bidirectional support
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   marginInlineStart?: SystemPropValues['space'];
   /**
    * - sets [CSS margin-inline-end property](https://developer.mozilla.org/en-US/docs/Web/CSS/margin-inline-end)
    * - bidirectional support
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   marginInlineEnd?: SystemPropValues['space'];
   /**
    * - sets [CSS padding-inline-start property](https://developer.mozilla.org/en-US/docs/Web/CSS/padding-inline-start)
    * - bidirectional support
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   paddingInlineStart?: SystemPropValues['space'];
   /**
    * - sets [CSS padding-inline-end property](https://developer.mozilla.org/en-US/docs/Web/CSS/padding-inline-end)
    * - bidirectional support
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   paddingInlineEnd?: SystemPropValues['space'];
   /**
    * - sets [CSS margin property](https://developer.mozilla.org/en-US/docs/Web/CSS/margin)
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   margin?: SystemPropValues['space'];
   /**
    * - sets [CSS margin-left](https://developer.mozilla.org/en-US/docs/Web/CSS/margin-left) and [margin-right properties](https://developer.mozilla.org/en-US/docs/Web/CSS/margin-right)
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   marginX?: SystemPropValues['space'];
   /**
    * - sets [CSS margin-top](https://developer.mozilla.org/en-US/docs/Web/CSS/margin-top) and [margin-bottom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/margin-bottom)
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   marginY?: SystemPropValues['space'];
   /**
    * - sets [CSS margin-top property](https://developer.mozilla.org/en-US/docs/Web/CSS/margin-top)
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   marginTop?: SystemPropValues['space'];
   /**
    * - sets [CSS margin-right property](https://developer.mozilla.org/en-US/docs/Web/CSS/margin-right)
    * - no bidirectional support
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   marginRight?: SystemPropValues['space'];
   /**
    * - sets [CSS margin-bottom property](https://developer.mozilla.org/en-US/docs/Web/CSS/margin-bottom)
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   marginBottom?: SystemPropValues['space'];
   /**
    * - sets [CSS margin-left property](https://developer.mozilla.org/en-US/docs/Web/CSS/margin-left)
    * - no bidirectional support
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   marginLeft?: SystemPropValues['space'];
   /**
    * - sets [CSS padding property](https://developer.mozilla.org/en-US/docs/Web/CSS/padding)
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   padding?: SystemPropValues['space'];
   /**
    * - sets [CSS padding-left]((https://developer.mozilla.org/en-US/docs/Web/CSS/padding-left) and [padding-right properties](https://developer.mozilla.org/en-US/docs/Web/CSS/padding-right)
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   paddingX?: SystemPropValues['space'];
   /**
    * - sets [CSS padding-top](https://developer.mozilla.org/en-US/docs/Web/CSS/padding-top) and [padding-bottom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/padding-bottom)
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   paddingY?: SystemPropValues['space'];
   /**
    * - sets [CSS padding-top property](https://developer.mozilla.org/en-US/docs/Web/CSS/padding-top)
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   paddingTop?: SystemPropValues['space'];
   /**
    * - sets [CSS padding-right property](https://developer.mozilla.org/en-US/docs/Web/CSS/padding-right)
    * - no bidirectional support
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   paddingRight?: SystemPropValues['space'];
   /**
    * - sets [CSS padding-bottom](https://developer.mozilla.org/en-US/docs/Web/CSS/padding)
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   paddingBottom?: SystemPropValues['space'];
   /**
    * - sets [CSS padding-left property](https://developer.mozilla.org/en-US/docs/Web/CSS/padding-left)
    * - no bidirectional support
    * - system tokens: `space`
-   * */
+   * @deprecated
+   */
   paddingLeft?: SystemPropValues['space'];
 };
 
+/** @deprecated */
 export const spaceStyleFnConfigs: StyleFnConfig[] = [
   {
     name: 'marginInlineStart',
@@ -196,6 +217,7 @@ export const spaceStyleFnConfigs: StyleFnConfig[] = [
   },
 ];
 
+/** @deprecated */
 export const spaceStyleFns = buildStyleFns(spaceStyleFnConfigs);
 /**
  * A style prop function that takes component props and returns space styles.
@@ -209,5 +231,6 @@ export const spaceStyleFns = buildStyleFns(spaceStyleFnConfigs);
  *   </Box>
  * );
  * ```
+ * @deprecated
  */
 export const space = buildStylePropFn<SpaceStyleProps>(spaceStyleFns);

package/layout/lib/utils/styleProps.ts

@@ -28,6 +28,7 @@ import {TextStyleProps} from './text';
  * - position
  * - space
  * - text
+ * @deprecated
  */
 export type CommonStyleProps = BackgroundStyleProps &
   BorderStyleProps &
@@ -48,6 +49,7 @@ export type CommonStyleProps = BackgroundStyleProps &
  * - common
  * - flex
  * - grid
+ * @deprecated ⚠️ Style props are deprecated. Please use our `cs` prop with `createStencil` or `createStyles` to apply styles. For more information view our [Styling docs](* @deprecated ⚠️ `boxStyleFn` is deprecated and will be removed in a future major version. Please reference our new way of styling components [here](https://workday.github.io/canvas-kit/?path=/docs/styling-getting-started-overview--docs).
  */
 export type AllStyleProps = CommonStyleProps &
   // Omitting 'display' here to default to the standard csstype type Property.Display

package/layout/lib/utils/systemProps.ts

@@ -6,6 +6,7 @@ import {
   CanvasTypeProperties,
 } from '@workday/canvas-kit-react/tokens';
 
+/** @deprecated */
 export type SystemPropNames =
   | 'color'
   | 'depth'
@@ -19,14 +20,22 @@ export type SystemPropNames =
  * Canvas System Prop Values
  * ---
  * These system prop values are restricted to Canvas token values.
+ * @deprecated
  */
 export type CanvasSystemPropValues = {
+  /** @deprecated */
   color: CanvasColor;
+  /** @deprecated */
   depth: keyof CanvasDepth;
+  /** @deprecated */
   font: keyof CanvasTypeProperties['fontFamilies'];
+  /** @deprecated */
   fontSize: keyof CanvasTypeProperties['fontSizes'];
+  /** @deprecated */
   fontWeight: keyof CanvasTypeProperties['fontWeights'];
+  /** @deprecated */
   shape: CanvasBorderRadiusKeys;
+  /** @deprecated */
   space: CanvasSpaceKeys;
 };
 
@@ -34,13 +43,21 @@ export type CanvasSystemPropValues = {
  * System Prop Values
  * ---
  * These system prop values include Canvas System Prop Values and generic values.
+ * @deprecated ⚠️ Style props are deprecated. Please use our `cs` prop with `createStencil` or `createStyles` to apply styles. For more information view our [Styling docs](* @deprecated ⚠️ `boxStyleFn` is deprecated and will be removed in a future major version. Please reference our new way of styling components [here](https://workday.github.io/canvas-kit/?path=/docs/styling-getting-started-overview--docs).
  */
 export type SystemPropValues = {
+  /** @deprecated */
   color: CanvasSystemPropValues['color'] | (string & {});
+  /** @deprecated */
   depth: CanvasSystemPropValues['depth'];
+  /** @deprecated */
   font: CanvasSystemPropValues['font'] | (string & {});
+  /** @deprecated */
   fontSize: CanvasSystemPropValues['fontSize'] | (string & {});
+  /** @deprecated */
   fontWeight: CanvasSystemPropValues['fontWeight'] | (string & {});
+  /** @deprecated */
   shape: CanvasSystemPropValues['shape'] | number | (string & {});
+  /** @deprecated */
   space: CanvasSystemPropValues['space'] | number | (string & {});
 };