@instructure/ui-billboard 8.14.0 → 8.14.1-snapshot.5

package/types/Billboard/index.d.ts

@@ -1,39 +1,41 @@
 /** @jsx jsx */
-import { Component } from 'react';
+import { Component, MouseEvent } from 'react';
 import { jsx } from '@instructure/emotion';
-import type { BillboardProps } from './props';
+import type { BillboardProps, HeroIconSize } from './props';
+import type { ViewProps } from '@instructure/ui-view';
 /**
 ---
 category: components
 ---
+@tsProps
 **/
 declare class Billboard extends Component<BillboardProps> {
     static readonly componentId = "Billboard";
     static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
-        hero?: import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | ((...args: any[]) => any) | undefined;
-        size?: "small" | "medium" | "large" | undefined;
+        hero?: import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | ((iconSize: HeroIconSize) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>) | undefined;
+        size?: "medium" | "large" | "small" | undefined;
         as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
         elementRef?: ((element: Element | null) => void) | undefined;
         heading?: string | undefined;
         headingAs?: "h1" | "h2" | "h3" | "span" | undefined;
         headingLevel?: "h1" | "h2" | "h3" | "h4" | undefined;
-        message?: import("react").ReactNode | ((...args: any[]) => any);
-        onClick?: ((...args: any[]) => any) | undefined;
+        message?: import("react").ReactNode | (() => import("react").ReactNode);
+        onClick?: ((e: MouseEvent<ViewProps, globalThis.MouseEvent>) => void) | undefined;
         href?: string | undefined;
         disabled?: boolean | undefined;
         readOnly?: boolean | undefined;
         margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined;
     }>;
     static allowedProps: readonly (keyof {
-        hero?: import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | ((...args: any[]) => any) | undefined;
-        size?: "small" | "medium" | "large" | undefined;
+        hero?: import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | ((iconSize: HeroIconSize) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>) | undefined;
+        size?: "medium" | "large" | "small" | undefined;
         as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
         elementRef?: ((element: Element | null) => void) | undefined;
         heading?: string | undefined;
         headingAs?: "h1" | "h2" | "h3" | "span" | undefined;
         headingLevel?: "h1" | "h2" | "h3" | "h4" | undefined;
-        message?: import("react").ReactNode | ((...args: any[]) => any);
-        onClick?: ((...args: any[]) => any) | undefined;
+        message?: import("react").ReactNode | (() => import("react").ReactNode);
+        onClick?: ((e: MouseEvent<ViewProps, globalThis.MouseEvent>) => void) | undefined;
         href?: string | undefined;
         disabled?: boolean | undefined;
         readOnly?: boolean | undefined;
@@ -51,13 +53,12 @@ declare class Billboard extends Component<BillboardProps> {
     ref: Element | null;
     handleRef: (el: Element | null) => void;
     componentDidMount(): void;
-    componentDidUpdate(prevProps: any, prevState: any, snapshot: any): void;
+    componentDidUpdate(): void;
     renderHeading(): jsx.JSX.Element;
-    get heroIsFunction(): boolean;
-    get SVGIconSize(): "medium" | "large" | "x-large";
-    renderHero(): any;
+    get SVGIconSize(): HeroIconSize;
+    renderHero(): import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | undefined;
     renderContent(): jsx.JSX.Element;
-    handleClick: (e: any) => void;
+    handleClick: (e: MouseEvent<ViewProps>) => void;
     render(): jsx.JSX.Element;
 }
 export default Billboard;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Billboard/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAUjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAMrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAE7C;;;;GAIG;AACH,cACM,SAAU,SAAQ,SAAS,CAAC,cAAc,CAAC;IAC/C,MAAM,CAAC,QAAQ,CAAC,WAAW,eAAc;IAEzC,MAAM,CAAC,SAAS;;;;;;;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;;;;;;MAQT;IAEV,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;IAED,iBAAiB;IAMjB,kBAAkB,CAAC,SAAS,KAAA,EAAE,SAAS,KAAA,EAAE,QAAQ,KAAA;IAKjD,aAAa;IAYb,IAAI,cAAc,YAEjB;IAED,IAAI,WAAW,mCAWd;IAED,UAAU;IASV,aAAa;IAeb,WAAW,mBASV;IAED,MAAM;CA0BP;AAED,eAAe,SAAS,CAAA;AACxB,OAAO,EAAE,SAAS,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Billboard/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AAU7C,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAMrD,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAErD;;;;;GAKG;AACH,cACM,SAAU,SAAQ,SAAS,CAAC,cAAc,CAAC;IAC/C,MAAM,CAAC,QAAQ,CAAC,WAAW,eAAc;IAEzC,MAAM,CAAC,SAAS;;;;;;;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;;;;;;MAQT;IAEV,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;IAED,iBAAiB;IAIjB,kBAAkB;IAIlB,aAAa;IAYb,IAAI,WAAW,IAAI,YAAY,CAW9B;IAED,UAAU;IAQV,aAAa;IAcb,WAAW,MAAO,WAAW,SAAS,CAAC,KAAG,IAAI,CAS7C;IAED,MAAM;CA0BP;AAED,eAAe,SAAS,CAAA;AACxB,OAAO,EAAE,SAAS,EAAE,CAAA"}

package/types/Billboard/props.d.ts

@@ -1,19 +1,66 @@
-/// <reference types="react" />
 import type { Spacing, WithStyleProps, ComponentStyle } from '@instructure/emotion';
 import type { AsElementType, BillboardTheme, OtherHTMLAttributes, PropValidators } from '@instructure/shared-types';
+import type { ViewProps } from '@instructure/ui-view';
+import React, { MouseEvent } from 'react';
+declare type HeroIconSize = 'medium' | 'x-large' | 'large';
 declare type BillboardOwnProps = {
-    hero?: React.ReactElement | ((...args: any[]) => any);
+    /**
+     * Provide an <Img> component or Instructure Icon for the hero image
+     */
+    hero?: React.ReactElement | ((iconSize: HeroIconSize) => React.ReactElement);
+    /**
+     * If you're using an icon, this prop will size it. Also sets the font-size
+     * of the headline and message.
+     */
     size?: 'small' | 'medium' | 'large';
+    /**
+     * the element type to render as
+     */
     as?: AsElementType;
+    /**
+     * provides a reference to the underlying html root element
+     */
     elementRef?: (element: Element | null) => void;
+    /**
+     * The headline for the Billboard. Is styled as an h1 element by default
+     */
     heading?: string;
+    /**
+     * Choose the appropriately semantic tag for the heading
+     */
     headingAs?: 'h1' | 'h2' | 'h3' | 'span';
+    /**
+     * Choose the font-size for the heading (see the Heading component)
+     */
     headingLevel?: 'h1' | 'h2' | 'h3' | 'h4';
-    message?: React.ReactNode | ((...args: any[]) => any);
-    onClick?: (...args: any[]) => any;
+    /**
+     * Instructions or information for the Billboard. Note: you should not pass
+     * interactive content to this prop if you are also providing an `href` or
+     * `onClick`. That would cause the Billboard to render as a button or link
+     * and would result in nested interactive content.
+     */
+    message?: React.ReactNode | (() => React.ReactNode);
+    /**
+     * If you add an onClick prop, the Billboard renders as a clickable button
+     */
+    onClick?: (e: MouseEvent<ViewProps>) => void;
+    /**
+     * If `href` is provided, Billboard will render as a link
+     */
     href?: string;
+    /**
+     * Whether or not to disable the billboard
+     */
     disabled?: boolean;
+    /**
+     * Works just like disabled but keeps the same styles as if it were active
+     */
     readOnly?: boolean;
+    /**
+     * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
+     * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
+     * familiar CSS-like shorthand. For example: `margin="small auto large"`.
+     */
     margin?: Spacing;
 };
 declare type PropKeys = keyof BillboardOwnProps;
@@ -22,6 +69,6 @@ declare type BillboardProps = BillboardOwnProps & WithStyleProps<BillboardTheme,
 declare type BillboardStyle = ComponentStyle<'billboard' | 'content' | 'hero' | 'heading' | 'message'>;
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;
-export type { BillboardProps, BillboardStyle };
+export type { BillboardProps, BillboardStyle, HeroIconSize };
 export { propTypes, allowedProps };
 //# sourceMappingURL=props.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Billboard/props.ts"],"names":[],"mappings":";AA4BA,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAElC,aAAK,iBAAiB,GAAG;IACvB,IAAI,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACrD,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,MAAM,CAAA;IACvC,YAAY,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;IACxC,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACrD,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACjC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,iBAAiB,CAAA;AAEvC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,cAAc,GAAG,iBAAiB,GACrC,cAAc,CAAC,cAAc,EAAE,cAAc,CAAC,GAC9C,mBAAmB,CAAC,iBAAiB,CAAC,CAAA;AAExC,aAAK,cAAc,GAAG,cAAc,CAClC,WAAW,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,CACzD,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CA2DvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAcnB,CAAA;AAED,YAAY,EAAE,cAAc,EAAE,cAAc,EAAE,CAAA;AAC9C,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Billboard/props.ts"],"names":[],"mappings":"AA4BA,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,KAAK,EAAE,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AACzC,aAAK,YAAY,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAA;AAClD,aAAK,iBAAiB,GAAG;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,QAAQ,EAAE,YAAY,KAAK,KAAK,CAAC,YAAY,CAAC,CAAA;IAC5E;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,MAAM,CAAA;IACvC;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;IACxC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IACnD;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,KAAK,IAAI,CAAA;IAC5C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,iBAAiB,CAAA;AAEvC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,cAAc,GAAG,iBAAiB,GACrC,cAAc,CAAC,cAAc,EAAE,cAAc,CAAC,GAC9C,mBAAmB,CAAC,iBAAiB,CAAC,CAAA;AAExC,aAAK,cAAc,GAAG,cAAc,CAClC,WAAW,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,CACzD,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAcvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAcnB,CAAA;AAED,YAAY,EAAE,cAAc,EAAE,cAAc,EAAE,YAAY,EAAE,CAAA;AAC5D,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}