@muraldevkit/ui-toolkit 1.11.0 → 1.12.0

package/dist/components/index.d.ts

@@ -4,3 +4,4 @@ export * from './tooltip';
 export * from './link';
 export * from './form';
 export * from './modal';
+export * from './text';

package/dist/components/text/MrlText/MrlText.d.ts

@@ -0,0 +1,38 @@
+import React from 'react';
+import { AttrsObject } from '../../../utils';
+import { TextHierarchies, TextKinds, TextSizes } from '../constants';
+interface CommonProps {
+    /** Applies additional HTML attributes to the text element */
+    attrs?: AttrsObject;
+    /** Children to be rendered within the text component */
+    children?: React.ReactNode | string;
+    /** Hierarchy level within the use case and sizing scales */
+    hierarchy?: TextHierarchies;
+    /** Textual content when it's a static string; if you have nested elements, use children to provide content */
+    text?: string;
+}
+interface DefaultKindWithSize extends CommonProps {
+    /**
+     * Visual kind of the text
+     * If the value is default it allows to change the "size" prop
+     */
+    kind: 'default';
+    /** Visual size of the text, only applies if kind="default" */
+    size: TextSizes;
+}
+interface KindWithoutSize extends CommonProps {
+    /**
+     * Visual kind of the text
+     * If the value is default it allows to change the "size" prop
+     */
+    kind: Exclude<TextKinds, 'default'>;
+}
+type MrlTextProps = DefaultKindWithSize | KindWithoutSize;
+/**
+ * MrlText Component
+ *
+ * @param {MrlTextProps} props - MrlText component props
+ * @returns a paragraph element
+ */
+export declare function MrlText(props: MrlTextProps): JSX.Element;
+export {};

package/dist/components/text/MrlText/index.d.ts

@@ -0,0 +1 @@
+export * from './MrlText';

package/dist/components/text/MrlTextHeading/MrlTextHeading.d.ts

@@ -0,0 +1,31 @@
+import React from 'react';
+import { AttrsObject } from '../../../utils';
+import { LevelType, HeadingSizes, TextSizes, TextHierarchies, HeadingKinds } from '../constants';
+interface MrlTextHeadingProps {
+    /** Applies additional HTML attributes to the text element */
+    attrs?: AttrsObject;
+    /** Children to be rendered within the text heading component */
+    children?: React.ReactNode;
+    /** Set the semantic level of the heading based on its usage in the page hierarchy */
+    level?: LevelType;
+    /** Visual styling use case for the heading */
+    kind?: HeadingKinds;
+    /**
+     * Visual size of the heading
+     * xsmall and xxsmall are only supported when kind="title"
+     */
+    size?: HeadingSizes | TextSizes;
+    /** Clear and concise description of the content that the heading describes */
+    text?: string;
+    /** Hierarchy level within the use case and sizing scales */
+    hierarchy?: TextHierarchies;
+}
+/**
+ * MuralTextHeading component
+ * Used for creating semantic headings within a page
+ *
+ * @param {MrlTextHeadingProps} props - MrlTextHeading component props
+ * @returns a heading element
+ */
+export declare function MrlTextHeading({ attrs, children, hierarchy, kind, level, size, text }: MrlTextHeadingProps): JSX.Element;
+export {};

package/dist/components/text/MrlTextHeading/index.d.ts

@@ -0,0 +1 @@
+export * from './MrlTextHeading';

package/dist/components/text/constants.d.ts

@@ -0,0 +1,44 @@
+import { AttrsObject } from '../../utils';
+export type TextSizes = 'xxsmall' | 'xsmall' | 'small' | 'medium' | 'large';
+export type TextHierarchies = 'primary' | 'secondary';
+export type TextKinds = 'default' | 'body' | 'meta' | 'supporting';
+export interface TextDefaults {
+    attrs: AttrsObject;
+    hierarchy: TextHierarchies;
+    size: TextSizes;
+    kind: TextKinds;
+}
+export declare const textAllowedValues: {
+    hierarchy: string[];
+    kind: string[];
+    sizes: string[];
+};
+/**
+ * Default values for props on the Text component;
+ * Shared between the component and Storybook
+ */
+export declare const textDefaults: TextDefaults;
+export type LevelType = '1' | '2' | '3' | '4' | '5' | '6';
+export type HeadingKinds = 'poster' | 'display' | 'headline' | 'title';
+export type HeadingSizes = 'small' | 'medium' | 'large';
+export interface HeadingDefaults {
+    attrs: AttrsObject;
+    hierarchy: TextHierarchies;
+    kind: HeadingKinds;
+    level: LevelType;
+    size: HeadingSizes | TextSizes;
+}
+/**
+ * Defines all of classes allowed for the type attribute;
+ * used for Storybook and testing
+ */
+export declare const headingAllowedValues: {
+    kinds: string[];
+    level: string[];
+    sizes: string[];
+};
+/**
+ * Default values for props on the Text component;
+ * Shared between the component and Storybook
+ */
+export declare const headingDefaults: HeadingDefaults;

package/dist/components/text/index.d.ts

@@ -0,0 +1,2 @@
+export * from './MrlText';
+export * from './MrlTextHeading';