@instructure/ui-heading 10.21.0 → 10.21.1-snapshot-1

package/types/Heading/index.d.ts

@@ -8,10 +8,11 @@ category: components
 declare class Heading extends Component<HeadingProps> {
     static readonly componentId = "Heading";
     static propTypes: import("@instructure/shared-types").PropValidators<keyof {
+        aiVariant?: "stacked" | "horizontal" | "iconOnly";
         children?: React.ReactNode;
         border?: "none" | "top" | "bottom";
         color?: "primary" | "secondary" | "primary-inverse" | "secondary-inverse" | "inherit" | "ai";
-        level?: ("h1" | "h2" | "h3" | "h4" | "h5") | "reset";
+        level?: ("h1" | "h2" | "h3" | "h4" | "h5" | "h6") | "reset";
         as?: import("@instructure/shared-types").AsElementType;
         margin?: import("@instructure/emotion").Spacing;
         elementRef?: (element: Element | null) => void;
@@ -19,10 +20,11 @@ declare class Heading extends Component<HeadingProps> {
         variant?: "titlePageDesktop" | "titlePageMobile" | "titleSection" | "titleCardSection" | "titleModule" | "titleCardLarge" | "titleCardRegular" | "titleCardMini" | "label" | "labelInline";
     }>;
     static allowedProps: readonly (keyof {
+        aiVariant?: "stacked" | "horizontal" | "iconOnly";
         children?: React.ReactNode;
         border?: "none" | "top" | "bottom";
         color?: "primary" | "secondary" | "primary-inverse" | "secondary-inverse" | "inherit" | "ai";
-        level?: ("h1" | "h2" | "h3" | "h4" | "h5") | "reset";
+        level?: ("h1" | "h2" | "h3" | "h4" | "h5" | "h6") | "reset";
         as?: import("@instructure/shared-types").AsElementType;
         margin?: import("@instructure/emotion").Spacing;
         elementRef?: (element: Element | null) => void;
@@ -41,6 +43,7 @@ declare class Heading extends Component<HeadingProps> {
     componentDidMount(): void;
     componentDidUpdate(): void;
     renderContent(): string | number | boolean | Iterable<import("react").ReactNode> | import("@emotion/react/jsx-runtime").JSX.Element | null | undefined;
+    getAriaLabel(): string | undefined;
     render(): import("@emotion/react/jsx-runtime").JSX.Element;
 }
 export default Heading;

package/types/Heading/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Heading/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAgBjC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAkB3C;;;;GAIG;AACH,cAEM,OAAQ,SAAQ,SAAS,CAAC,YAAY,CAAC;IAC3C,MAAM,CAAC,QAAQ,CAAC,WAAW,aAAY;IAEvC,MAAM,CAAC,SAAS;;;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;;;MAKT;IAEV,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,GAAI,IAAI,OAAO,GAAG,IAAI,UAQ9B;IAED,UAAU;IASV,iBAAiB;IAKjB,kBAAkB;IAKlB,aAAa;IAab,MAAM;CAyCP;AAED,eAAe,OAAO,CAAA;AACtB,OAAO,EAAE,OAAO,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Heading/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAiBjC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAkB3C;;;;GAIG;AACH,cAEM,OAAQ,SAAQ,SAAS,CAAC,YAAY,CAAC;IAC3C,MAAM,CAAC,QAAQ,CAAC,WAAW,aAAY;IAEvC,MAAM,CAAC,SAAS;;;;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;;;MAKT;IAEV,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,GAAI,IAAI,OAAO,GAAG,IAAI,UAQ9B;IAED,UAAU;IASV,iBAAiB;IAKjB,kBAAkB;IAKlB,aAAa;IA0Cb,YAAY;IAWZ,MAAM;CA0CP;AAED,eAAe,OAAO,CAAA;AACtB,OAAO,EAAE,OAAO,EAAE,CAAA"}

package/types/Heading/props.d.ts

@@ -2,6 +2,10 @@ import type { AsElementType, PropValidators, HeadingTheme, OtherHTMLAttributes,
 import type { Spacing, WithStyleProps, ComponentStyle } from '@instructure/emotion';
 type HeadingLevel<U extends keyof JSX.IntrinsicElements> = U;
 type HeadingOwnProps = {
+    /**
+     * transforms heading into an ai variant
+     */
+    aiVariant?: 'stacked' | 'horizontal' | 'iconOnly';
     /**
      * The text content of the Heading
      */
@@ -11,13 +15,13 @@ type HeadingOwnProps = {
      */
     border?: 'none' | 'top' | 'bottom';
     /**
-     * The font color to render
+     * The font color to render, NOTE: `ai` color is deprecated. Use the `aiVariant` prop instead
      */
     color?: 'primary' | 'secondary' | 'primary-inverse' | 'secondary-inverse' | 'inherit' | 'ai';
     /**
      * The *visual* appearance of the Heading: h1 is largest; h5 is smallest.
      */
-    level?: HeadingLevel<'h1' | 'h2' | 'h3' | 'h4' | 'h5'> | 'reset';
+    level?: HeadingLevel<'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'> | 'reset';
     /**
      * Choose the element Heading should render as. Will default to the `level` prop
      * if not specified.
@@ -45,7 +49,7 @@ type HeadingOwnProps = {
 type PropKeys = keyof HeadingOwnProps;
 type AllowedPropKeys = Readonly<Array<PropKeys>>;
 type HeadingProps = HeadingOwnProps & WithStyleProps<HeadingTheme, HeadingStyle> & OtherHTMLAttributes<HeadingOwnProps>;
-type HeadingStyle = ComponentStyle<'heading'>;
+type HeadingStyle = ComponentStyle<'heading' | 'igniteAI' | 'igniteAIStacked' | 'withIcon'>;
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;
 export type { HeadingProps, HeadingStyle };

package/types/Heading/props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Heading/props.ts"],"names":[],"mappings":"AA4BA,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,UAAU,EACX,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAE7B,KAAK,YAAY,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,iBAAiB,IAAI,CAAC,CAAA;AAE5D,KAAK,eAAe,GAAG;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAA;IAClC;;OAEG;IACH,KAAK,CAAC,EACF,SAAS,GACT,WAAW,GACX,iBAAiB,GACjB,mBAAmB,GACnB,SAAS,GACT,IAAI,CAAA;IACR;;OAEG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC,GAAG,OAAO,CAAA;IAChE;;;OAGG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB;;OAEG;IACH,OAAO,CAAC,EACJ,kBAAkB,GAClB,iBAAiB,GACjB,cAAc,GACd,kBAAkB,GAClB,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,eAAe,GACf,OAAO,GACP,aAAa,CAAA;CAClB,CAAA;AAED,KAAK,QAAQ,GAAG,MAAM,eAAe,CAAA;AAErC,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,YAAY,GAAG,eAAe,GACjC,cAAc,CAAC,YAAY,EAAE,YAAY,CAAC,GAC1C,mBAAmB,CAAC,eAAe,CAAC,CAAA;AAEtC,KAAK,YAAY,GAAG,cAAc,CAAC,SAAS,CAAC,CAAA;AAE7C,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CA4BvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eASnB,CAAA;AAED,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,CAAA;AAC1C,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Heading/props.ts"],"names":[],"mappings":"AA4BA,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,UAAU,EACX,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAE7B,KAAK,YAAY,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,iBAAiB,IAAI,CAAC,CAAA;AAE5D,KAAK,eAAe,GAAG;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,GAAG,YAAY,GAAG,UAAU,CAAA;IACjD;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAA;IAClC;;OAEG;IACH,KAAK,CAAC,EACF,SAAS,GACT,WAAW,GACX,iBAAiB,GACjB,mBAAmB,GACnB,SAAS,GACT,IAAI,CAAA;IACR;;OAEG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC,GAAG,OAAO,CAAA;IACvE;;;OAGG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB;;OAEG;IACH,OAAO,CAAC,EACJ,kBAAkB,GAClB,iBAAiB,GACjB,cAAc,GACd,kBAAkB,GAClB,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,eAAe,GACf,OAAO,GACP,aAAa,CAAA;CAClB,CAAA;AAED,KAAK,QAAQ,GAAG,MAAM,eAAe,CAAA;AAErC,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,YAAY,GAAG,eAAe,GACjC,cAAc,CAAC,YAAY,EAAE,YAAY,CAAC,GAC1C,mBAAmB,CAAC,eAAe,CAAC,CAAA;AAEtC,KAAK,YAAY,GAAG,cAAc,CAChC,SAAS,GAAG,UAAU,GAAG,iBAAiB,GAAG,UAAU,CACxD,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CA6BvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAUnB,CAAA;AAED,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,CAAA;AAC1C,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}

package/types/Heading/styles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../src/Heading/styles.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAEzD;;;;;;;;;GASG;AACH,QAAA,MAAM,aAAa,GACjB,gBAAgB,YAAY,EAC5B,OAAO,YAAY,KAClB,YAuKF,CAAA;AACD,eAAe,aAAa,CAAA"}
+{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../src/Heading/styles.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAEzD;;;;;;;;;GASG;AACH,QAAA,MAAM,aAAa,GACjB,gBAAgB,YAAY,EAC5B,OAAO,YAAY,KAClB,YAgMF,CAAA;AACD,eAAe,aAAa,CAAA"}

package/types/Heading/theme.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../src/Heading/theme.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,KAAK,EAAsB,MAAM,wBAAwB,CAAA;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAExD;;;;GAIG;AACH,QAAA,MAAM,sBAAsB,GAAI,OAAO,KAAK,KAAG,YA+D9C,CAAA;AAED,eAAe,sBAAsB,CAAA"}
+{"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../src/Heading/theme.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,KAAK,EAAsB,MAAM,wBAAwB,CAAA;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAExD;;;;GAIG;AACH,QAAA,MAAM,sBAAsB,GAAI,OAAO,KAAK,KAAG,YAyD9C,CAAA;AAED,eAAe,sBAAsB,CAAA"}