@instructure/ui-byline 11.7.2-snapshot-21 → 11.7.2-snapshot-23

package/types/Byline/v2/index.d.ts

@@ -0,0 +1,30 @@
+import { Component } from 'react';
+import type { BylineProps } from './props';
+/**
+---
+category: components
+---
+**/
+declare class Byline extends Component<BylineProps> {
+    static readonly componentId = "Byline";
+    static allowedProps: readonly (keyof {
+        children: React.ReactNode;
+        title?: React.ReactNode;
+        description?: string | React.ReactNode;
+        alignContent?: "top" | "center";
+        margin?: import("@instructure/emotion").Spacing;
+        size?: "small" | "medium" | "large";
+        elementRef?: (element: Element | null) => void;
+    })[];
+    static defaultProps: {
+        alignContent: string;
+    };
+    ref: Element | null;
+    handleRef: (el: Element | null) => void;
+    componentDidMount(): void;
+    componentDidUpdate(): void;
+    render(): import("@emotion/react/jsx-runtime").JSX.Element;
+}
+export default Byline;
+export { Byline };
+//# sourceMappingURL=index.d.ts.map

package/types/Byline/v2/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Byline/v2/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAUjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAE1C;;;;GAIG;AAEH,cACM,MAAO,SAAQ,SAAS,CAAC,WAAW,CAAC;IACzC,MAAM,CAAC,QAAQ,CAAC,WAAW,YAAW;IAEtC,MAAM,CAAC,YAAY;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;MAElB;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,GAAI,IAAI,OAAO,GAAG,IAAI,UAQ9B;IAED,iBAAiB;IAIjB,kBAAkB;IAIlB,MAAM;CA4BP;AAED,eAAe,MAAM,CAAA;AACrB,OAAO,EAAE,MAAM,EAAE,CAAA"}

package/types/Byline/v2/props.d.ts

@@ -0,0 +1,42 @@
+import React from 'react';
+import type { Spacing, WithStyleProps, ComponentStyle } from '@instructure/emotion';
+import type { BylineTheme, OtherHTMLAttributes } from '@instructure/shared-types';
+type BylineOwnProps = {
+    /**
+     * the Byline visual/object
+     */
+    children: React.ReactNode;
+    /**
+     * the Byline title
+     */
+    title?: React.ReactNode;
+    /**
+     * the Byline description
+     */
+    description?: string | React.ReactNode;
+    /**
+     * how should the title and description align
+     */
+    alignContent?: 'top' | 'center';
+    /**
+     * 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;
+    size?: 'small' | 'medium' | 'large';
+    /**
+     * Provides a reference to the underlying html root element
+     */
+    elementRef?: (element: Element | null) => void;
+};
+type PropKeys = keyof BylineOwnProps;
+type AllowedPropKeys = Readonly<Array<PropKeys>>;
+type BylineProps = BylineOwnProps & WithStyleProps<BylineTheme, BylineStyle> & OtherHTMLAttributes<BylineOwnProps>;
+type BylineStyle = ComponentStyle<'byline' | 'figure' | 'caption' | 'title' | 'description' | 'maxWidth'> & {
+    maxWidth?: string;
+};
+declare const allowedProps: AllowedPropKeys;
+export type { BylineProps, BylineStyle };
+export { allowedProps };
+//# sourceMappingURL=props.d.ts.map

package/types/Byline/v2/props.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/Byline/v2/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,WAAW,EACX,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAElC,KAAK,cAAc,GAAG;IACpB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,SAAS,CAAA;IACtC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAA;IAC/B;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAIhB,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;CAC/C,CAAA;AAED,KAAK,QAAQ,GAAG,MAAM,cAAc,CAAA;AAEpC,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,WAAW,GAAG,cAAc,GAC/B,cAAc,CAAC,WAAW,EAAE,WAAW,CAAC,GACxC,mBAAmB,CAAC,cAAc,CAAC,CAAA;AAErC,KAAK,WAAW,GAAG,cAAc,CAC/B,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,GAAG,aAAa,GAAG,UAAU,CACvE,GAAG;IACF,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AACD,QAAA,MAAM,YAAY,EAAE,eAQnB,CAAA;AAED,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,CAAA;AACxC,OAAO,EAAE,YAAY,EAAE,CAAA"}

package/types/Byline/v2/styles.d.ts

@@ -0,0 +1,15 @@
+import type { NewComponentTypes, SharedTokens } from '@instructure/ui-themes';
+import type { BylineProps, BylineStyle } from './props';
+/**
+ * ---
+ * private: true
+ * ---
+ * Generates the style object from the theme and provided additional information
+ * @param componentTheme The theme variable object.
+ * @param params Additional parameters to customize the style.
+ * @param sharedTokens Shared token object that stores common values for the theme.
+ * @return The final style object, which will be used in the component
+ */
+declare const generateStyle: (componentTheme: NewComponentTypes["Byline"], params: BylineProps, _sharedTokens: SharedTokens) => BylineStyle;
+export default generateStyle;
+//# sourceMappingURL=styles.d.ts.map

package/types/Byline/v2/styles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../../src/Byline/v2/styles.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAC7E,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAEvD;;;;;;;;;GASG;AACH,QAAA,MAAM,aAAa,GACjB,gBAAgB,iBAAiB,CAAC,QAAQ,CAAC,EAC3C,QAAQ,WAAW,EACnB,eAAe,YAAY,KAC1B,WAwEF,CAAA;AAED,eAAe,aAAa,CAAA"}

package/types/exports/b.d.ts

@@ -0,0 +1,3 @@
+export { Byline } from '../Byline/v2';
+export type { BylineProps } from '../Byline/v2/props';
+//# sourceMappingURL=b.d.ts.map

package/types/exports/b.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"b.d.ts","sourceRoot":"","sources":["../../src/exports/b.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,YAAY,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA"}