@bspk/ui 1.1.34 → 1.3.0

package/src/components/FormField/FormField.rtl.test.tsx

@@ -0,0 +1,30 @@
+import { FormField } from './FormField';
+import { TextInput } from '-/components/TextInput';
+import { hasNoBasicA11yIssues } from '-/rtl/hasNoBasicA11yIssues';
+import { render } from '-/rtl/util';
+
+const TestBed = () => (
+    <FormField controlId="Example controlId" label="Example label">
+        {(fieldProps) => {
+            return (
+                <TextInput
+                    aria-label="example aria-label"
+                    name="example-text"
+                    onChange={() => {}}
+                    value="Input text"
+                    {...fieldProps}
+                />
+            );
+        }}
+    </FormField>
+);
+
+describe('FormField (RTL)', () => {
+    it('has no basic a11y issues', hasNoBasicA11yIssues(<TestBed />));
+
+    it('renders', () => {
+        const { getByLabelText } = render(<TestBed />);
+
+        expect(getByLabelText('example aria-label')).toBeInTheDocument();
+    });
+});

package/src/components/FormField/FormField.tsx

@@ -1,49 +1,40 @@
-import { CommonProps, ElementProps, InvalidPropsLibrary } from '-';
+import './form-field.scss';
 import { InlineAlert } from '-/components/InlineAlert';
 import { Txt } from '-/components/Txt';
-import './form-field.scss';
+import { CommonProps, ElementProps, FormFieldControlProps } from '-/types/common';
+
+// omits are usually a code smell, but in this case, we need to ensure we get all the props from child components
+export type FormFieldWrapProps<T extends Record<string, unknown>> = Omit<FormFieldProps, keyof T | 'children'> &
+    Omit<T, 'aria-describedby' | 'aria-errormessage'>;
 
-export type FieldControlProps = {
+export type FormFieldProps = CommonProps<'invalid' | 'required'> & {
+    /** The error message to display when the field is invalid. */
+    errorMessage?: string;
     /**
-     * Marks the element as invalid and displays error message.
+     * The label of the field.
      *
-     * @default false
+     * @required
      */
-    invalid?: boolean;
-    /** The id of the control description. */
-    'aria-describedby'?: string;
-    /** The id of the error message */
-    'aria-errormessage'?: string;
+    label: string;
+    /** The id of the control. */
+    controlId: string;
+    /**
+     * The children of the form field. This should be a control such as TextInput, Select, DateInput, or TimeInput.
+     *
+     * @type (childProps: FormFieldControlProps) => JSX.Element
+     * @required
+     */
+    children: (childProps: FormFieldControlProps) => JSX.Element;
+    /** The helperText of the field. */
+    helperText?: string;
+    /** The trailing element of the label. */
+    labelTrailing?: React.ReactNode;
 };
 
-export type FormFieldProps = CommonProps<'required'> &
-    InvalidPropsLibrary & {
-        /**
-         * The label of the field.
-         *
-         * @required
-         */
-        label: string;
-        /** The id of the control. */
-        controlId: string;
-        /**
-         * The children of the form field. This should be a control such as TextInput, Select, DatePicker, or
-         * TimePicker.
-         *
-         * @type (childProps: FieldControlProps) => JSX.Element
-         * @required
-         */
-        children: (childProps: FieldControlProps) => JSX.Element;
-        /** The helperText of the field. */
-        helperText?: string;
-        /** The trailing element of the label. */
-        labelTrailing?: React.ReactNode;
-    };
-
 /**
  * Wrapper component for form controls.
  *
- * Children may be one of the following: TextInput, Select, DatePicker, or TimePicker.
+ * Children should be one of the following: TextInput, Select, DateInput or TimeInput.
  *
  * @example
  *     import { TextInput } from '@bspk/ui/TextInput';
@@ -71,9 +62,9 @@ export type FormFieldProps = CommonProps<'required'> &
  *     }
  *
  * @name FormField
- * @phase Backlog
+ * @phase Utility
  */
-function FormField({
+export function FormField({
     label,
     invalid,
     errorMessage: errorMessageProp,
@@ -82,16 +73,17 @@ function FormField({
     labelTrailing,
     controlId,
     required,
+    ...props
 }: ElementProps<FormFieldProps, 'div'>) {
     const errorMessage = invalid && errorMessageProp ? errorMessageProp : undefined;
     const errorMessageId = errorMessage ? `${controlId}-error-message` : undefined;
-    const helperText = !invalid && helperTextProp ? helperTextProp : undefined;
+    const helperText = !errorMessage && helperTextProp ? helperTextProp : undefined;
     const helperTextId = !errorMessage && helperText ? `${controlId}-helper-text` : undefined;
 
     if (typeof children !== 'function') return null;
 
     return (
-        <div data-bspk="form-field" data-invalid={invalid || undefined}>
+        <div {...props} data-bspk-utility="form-field" data-invalid={invalid || undefined}>
             <header>
                 <label htmlFor={controlId}>
                     <Txt as="span" variant="labels-small">
@@ -106,7 +98,6 @@ function FormField({
                 {labelTrailing}
             </header>
             {children({
-                invalid,
                 'aria-describedby': helperTextId,
                 'aria-errormessage': errorMessageId,
             })}
@@ -124,8 +115,4 @@ function FormField({
     );
 }
 
-FormField.bspkName = 'FormField';
-
-export { FormField };
-
 /** Copyright 2025 Anywhere Real Estate - CC BY 4.0 */

package/src/components/FormField/FormFieldExample.tsx

@@ -0,0 +1,41 @@
+import { FormFieldWrapProps, FormField } from './FormField';
+import { TextInput, TextInputProps } from '-/components/TextInput';
+import { ComponentExample } from '-/utils/demo';
+
+export const FormFieldExample: ComponentExample<FormFieldWrapProps<TextInputProps>> = {
+    render: ({ props, setState }) => {
+        const {
+            invalid,
+            errorMessage,
+            label,
+            controlId = 'example-control-id',
+            helperText,
+            labelTrailing,
+            ...inputProps
+        } = props;
+
+        return (
+            <FormField
+                controlId={controlId}
+                errorMessage={errorMessage}
+                helperText={helperText}
+                invalid={invalid}
+                label={label}
+                labelTrailing={labelTrailing}
+            >
+                {(fieldProps) => {
+                    return (
+                        <TextInput
+                            {...inputProps}
+                            {...fieldProps}
+                            aria-label={label}
+                            invalid={invalid}
+                            onChange={(next: string) => setState({ value: next })}
+                            value={props.value}
+                        />
+                    );
+                }}
+            </FormField>
+        );
+    },
+};

package/src/components/FormField/form-field.scss

@@ -1,4 +1,4 @@
-[data-bspk='form-field'] {
+[data-bspk-utility='form-field'] {
     width: 100%;
     display: flex;
     flex-direction: column;

package/src/components/Img/Img.rtl.test.tsx

@@ -0,0 +1,15 @@
+import { Img } from './Img';
+import { hasNoBasicA11yIssues } from '-/rtl/hasNoBasicA11yIssues';
+import { render } from '-/rtl/util';
+
+const TestBed = () => <Img alt="Example alt" src="Example src" />;
+
+describe('Img (RTL)', () => {
+    it('has no basic a11y issues', hasNoBasicA11yIssues(<TestBed />));
+
+    it('renders', () => {
+        const { getByAltText } = render(<TestBed />);
+
+        expect(getByAltText('Example alt')).toBeInTheDocument();
+    });
+});

package/src/components/Img/Img.tsx

@@ -1,4 +1,4 @@
-import { ElementProps } from '-';
+import { ElementProps } from '-/types/common';
 
 export type ImgProps = {
     /**
@@ -28,12 +28,8 @@ export type ImgProps = {
  * @name Img
  * @phase Backlog
  */
-function Img({ alt, ...props }: ElementProps<ImgProps, 'img'>) {
+export function Img({ alt, ...props }: ElementProps<ImgProps, 'img'>) {
     return <img {...props} alt={alt} data-bspk="img" />;
 }
 
-Img.bspkName = 'Img';
-
-export { Img };
-
 /** Copyright 2025 Anywhere Real Estate - CC BY 4.0 */

package/src/components/InlineAlert/InlineAlert.rtl.test.tsx

@@ -0,0 +1,15 @@
+import { InlineAlert } from './InlineAlert';
+import { hasNoBasicA11yIssues } from '-/rtl/hasNoBasicA11yIssues';
+import { render } from '-/rtl/util';
+
+const TestBed = () => <InlineAlert variant="informational">Example informational inline alert</InlineAlert>;
+
+describe('InlineAlert (RTL)', () => {
+    it('has no basic a11y issues', hasNoBasicA11yIssues(<TestBed />));
+
+    it('renders', () => {
+        const { getByText } = render(<TestBed />);
+
+        expect(getByText('Example informational inline alert')).toBeInTheDocument();
+    });
+});

package/src/components/InlineAlert/InlineAlert.tsx

@@ -1,11 +1,11 @@
+import './inline-alert.scss';
 import { SvgCheckCircleFill } from '@bspk/icons/CheckCircleFill';
 import { SvgErrorFill } from '@bspk/icons/ErrorFill';
 import { SvgInfoFill } from '@bspk/icons/InfoFill';
 import { ReactNode } from 'react';
-
-import { AlertVariant } from '-';
+import { SvgWarningTwoTone } from './SvgWarningTwoTone';
 import { Txt } from '-/components/Txt';
-import './inline-alert.scss';
+import { AlertVariant } from '-/types/common';
 
 export type InlineAlertProps = {
     /**
@@ -37,39 +37,17 @@ export type InlineAlertProps = {
  *     }
  *
  * @name InlineAlert
- * @phase DesignReview
+ * @phase UXReview
  */
-function InlineAlert({ children, variant = 'informational', id }: InlineAlertProps) {
+export function InlineAlert({ children, variant = 'informational', id }: InlineAlertProps) {
     return (
-        <div data-bspk="inline-alert" data-variant={variant} id={id}>
+        <div data-bspk="inline-alert" data-variant={variant} id={id} role="alert">
             {VARIANT_ICON[variant]}
             <Txt variant="body-small">{children}</Txt>
         </div>
     );
 }
 
-InlineAlert.bspkName = 'InlineAlert';
-
-export { InlineAlert };
-
-// eslint-disable-next-line react/no-multi-comp
-const SvgWarningTwoTone = () => (
-    <svg fill="none" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
-        <path
-            d="M2.72503 21C2.5417 21 2.37503 20.9542 2.22503 20.8625C2.07503 20.7708 1.95837 20.65 1.87503 20.5C1.7917 20.35 1.74587 20.1875 1.73753 20.0125C1.7292 19.8375 1.77503 19.6667 1.87503 19.5L11.125 3.5C11.225 3.33333 11.3542 3.20833 11.5125 3.125C11.6709 3.04167 11.8334 3 12 3C12.1667 3 12.3292 3.04167 12.4875 3.125C12.6459 3.20833 12.775 3.33333 12.875 3.5L22.125 19.5C22.225 19.6667 22.2709 19.8375 22.2625 20.0125C22.2542 20.1875 22.2084 20.35 22.125 20.5C22.0417 20.65 21.925 20.7708 21.775 20.8625C21.625 20.9542 21.4584 21 21.275 21H2.72503ZM12 18C12.2834 18 12.5209 17.9042 12.7125 17.7125C12.9042 17.5208 13 17.2833 13 17C13 16.7167 12.9042 16.4792 12.7125 16.2875C12.5209 16.0958 12.2834 16 12 16C11.7167 16 11.4792 16.0958 11.2875 16.2875C11.0959 16.4792 11 16.7167 11 17C11 17.2833 11.0959 17.5208 11.2875 17.7125C11.4792 17.9042 11.7167 18 12 18ZM12 15C12.2834 15 12.5209 14.9042 12.7125 14.7125C12.9042 14.5208 13 14.2833 13 14V11C13 10.7167 12.9042 10.4792 12.7125 10.2875C12.5209 10.0958 12.2834 10 12 10C11.7167 10 11.4792 10.0958 11.2875 10.2875C11.0959 10.4792 11 10.7167 11 11V14C11 14.2833 11.0959 14.5208 11.2875 14.7125C11.4792 14.9042 11.7167 15 12 15Z"
-            fill="currentColor"
-        />
-        <path
-            d="M12.7125 17.7125C12.5208 17.9042 12.2833 18 12 18C11.7167 18 11.4792 17.9042 11.2875 17.7125C11.0958 17.5208 11 17.2833 11 17C11 16.7167 11.0958 16.4792 11.2875 16.2875C11.4792 16.0958 11.7167 16 12 16C12.2833 16 12.5208 16.0958 12.7125 16.2875C12.9042 16.4792 13 16.7167 13 17C13 17.2833 12.9042 17.5208 12.7125 17.7125Z"
-            data-second-tone
-        />
-        <path
-            d="M12.7125 14.7125C12.5208 14.9042 12.2833 15 12 15C11.7167 15 11.4792 14.9042 11.2875 14.7125C11.0958 14.5208 11 14.2833 11 14V11C11 10.7167 11.0958 10.4792 11.2875 10.2875C11.4792 10.0958 11.7167 10 12 10C12.2833 10 12.5208 10.0958 12.7125 10.2875C12.9042 10.4792 13 10.7167 13 11V14C13 14.2833 12.9042 14.5208 12.7125 14.7125Z"
-            data-second-tone
-        />
-    </svg>
-);
-
 const VARIANT_ICON: Record<AlertVariant, ReactNode> = {
     error: <SvgErrorFill />,
     informational: <SvgInfoFill />,

package/src/components/InlineAlert/SvgWarningTwoTone.tsx

@@ -0,0 +1,18 @@
+export function SvgWarningTwoTone() {
+    return (
+        <svg fill="none" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
+            <path
+                d="M2.72503 21C2.5417 21 2.37503 20.9542 2.22503 20.8625C2.07503 20.7708 1.95837 20.65 1.87503 20.5C1.7917 20.35 1.74587 20.1875 1.73753 20.0125C1.7292 19.8375 1.77503 19.6667 1.87503 19.5L11.125 3.5C11.225 3.33333 11.3542 3.20833 11.5125 3.125C11.6709 3.04167 11.8334 3 12 3C12.1667 3 12.3292 3.04167 12.4875 3.125C12.6459 3.20833 12.775 3.33333 12.875 3.5L22.125 19.5C22.225 19.6667 22.2709 19.8375 22.2625 20.0125C22.2542 20.1875 22.2084 20.35 22.125 20.5C22.0417 20.65 21.925 20.7708 21.775 20.8625C21.625 20.9542 21.4584 21 21.275 21H2.72503ZM12 18C12.2834 18 12.5209 17.9042 12.7125 17.7125C12.9042 17.5208 13 17.2833 13 17C13 16.7167 12.9042 16.4792 12.7125 16.2875C12.5209 16.0958 12.2834 16 12 16C11.7167 16 11.4792 16.0958 11.2875 16.2875C11.0959 16.4792 11 16.7167 11 17C11 17.2833 11.0959 17.5208 11.2875 17.7125C11.4792 17.9042 11.7167 18 12 18ZM12 15C12.2834 15 12.5209 14.9042 12.7125 14.7125C12.9042 14.5208 13 14.2833 13 14V11C13 10.7167 12.9042 10.4792 12.7125 10.2875C12.5209 10.0958 12.2834 10 12 10C11.7167 10 11.4792 10.0958 11.2875 10.2875C11.0959 10.4792 11 10.7167 11 11V14C11 14.2833 11.0959 14.5208 11.2875 14.7125C11.4792 14.9042 11.7167 15 12 15Z"
+                fill="currentColor"
+            />
+            <path
+                d="M12.7125 17.7125C12.5208 17.9042 12.2833 18 12 18C11.7167 18 11.4792 17.9042 11.2875 17.7125C11.0958 17.5208 11 17.2833 11 17C11 16.7167 11.0958 16.4792 11.2875 16.2875C11.4792 16.0958 11.7167 16 12 16C12.2833 16 12.5208 16.0958 12.7125 16.2875C12.9042 16.4792 13 16.7167 13 17C13 17.2833 12.9042 17.5208 12.7125 17.7125Z"
+                data-second-tone
+            />
+            <path
+                d="M12.7125 14.7125C12.5208 14.9042 12.2833 15 12 15C11.7167 15 11.4792 14.9042 11.2875 14.7125C11.0958 14.5208 11 14.2833 11 14V11C11 10.7167 11.0958 10.4792 11.2875 10.2875C11.4792 10.0958 11.7167 10 12 10C12.2833 10 12.5208 10.0958 12.7125 10.2875C12.9042 10.4792 13 10.7167 13 11V14C13 14.2833 12.9042 14.5208 12.7125 14.7125Z"
+                data-second-tone
+            />
+        </svg>
+    );
+}

package/src/components/InlineAlert/inline-alert.scss

@@ -41,6 +41,7 @@
         color: var(--first-tone);
         width: var(--spacing-sizing-05);
         height: var(--spacing-sizing-05);
+        flex: 0 0 auto;
 
         [data-second-tone] {
             fill: var(--second-tone);

package/src/components/Layout/Layout.rtl.test.tsx

@@ -0,0 +1,15 @@
+import { Layout } from './Layout';
+import { hasNoBasicA11yIssues } from '-/rtl/hasNoBasicA11yIssues';
+import { render } from '-/rtl/util';
+
+const TestBed = () => <Layout>Example layout</Layout>;
+
+describe('Layout (RTL)', () => {
+    it('has no basic a11y issues', hasNoBasicA11yIssues(<TestBed />));
+
+    it('renders', () => {
+        const { getByText } = render(<TestBed />);
+
+        expect(getByText('Example layout')).toBeInTheDocument();
+    });
+});

package/src/components/Layout/Layout.tsx

@@ -1,6 +1,6 @@
 import { ElementType, ReactNode } from 'react';
 
-import { ElementProps } from '-';
+import { ElementProps } from '-/types/common';
 
 export type LayoutProps<As extends ElementType = 'div'> = {
     /**
@@ -25,13 +25,13 @@ export type LayoutProps<As extends ElementType = 'div'> = {
      */
     as?: As;
     /**
-     * Additional styles to apply to the Layout.
+     * The alignment style to apply to the Layout.
      *
      * @default flex-start
      */
     align?: 'center' | 'flex-end' | 'flex-start' | 'stretch';
     /**
-     * Additional styles to apply to the Layout.
+     * The justification style to apply to the Layout.
      *
      * @default flex-start
      */
@@ -51,7 +51,7 @@ export type LayoutProps<As extends ElementType = 'div'> = {
  * @name Layout
  * @phase Utility
  */
-function Layout<As extends ElementType = 'div'>({
+export function Layout<As extends ElementType = 'div'>({
     children,
     column,
     gap = '16',
@@ -84,8 +84,4 @@ function Layout<As extends ElementType = 'div'>({
     );
 }
 
-Layout.bspkName = 'Layout';
-
-export { Layout };
-
 /** Copyright 2025 Anywhere Real Estate - CC BY 4.0 */

package/src/components/Layout/LayoutExample.tsx

@@ -0,0 +1,17 @@
+import { LayoutProps } from './Layout';
+import { ComponentExample, Preset } from '-/utils/demo';
+
+export const presets: Preset<LayoutProps>[] = [];
+
+export const LayoutExample: ComponentExample<LayoutProps> = {
+    render: ({ props, Component }) => {
+        return (
+            <Component {...props}>
+                <div>Alpha</div>
+                <div>Beta</div>
+                <div>Gamma</div>
+            </Component>
+        );
+    },
+    presets,
+};

package/src/components/Link/Link.rtl.test.tsx

@@ -0,0 +1,14 @@
+import { Link } from './Link';
+import { hasNoBasicA11yIssues } from '-/rtl/hasNoBasicA11yIssues';
+import { render } from '-/rtl/util';
+
+const TestBed = () => <Link href="https://bspk.dev" label="Example link" trailingIcon="external" />;
+
+describe('Link (RTL)', () => {
+    it('has no basic a11y issues', hasNoBasicA11yIssues(<TestBed />));
+
+    it('renders', async () => {
+        const { findByText } = render(<TestBed />);
+        expect(await findByText('Example link')).toBeInTheDocument();
+    });
+});

package/src/components/Link/Link.tsx

@@ -1,8 +1,6 @@
-import { AnchorHTMLAttributes, ComponentType, lazy, LazyExoticComponent, Suspense } from 'react';
-
-import { CommonPropsLibrary, ElementProps } from '-';
-
 import './link.scss';
+import { AnchorHTMLAttributes, ComponentType, lazy, LazyExoticComponent, Suspense } from 'react';
+import { CommonPropsLibrary, ElementProps } from '-/types/common';
 
 export type LinkProps = Pick<CommonPropsLibrary, 'disabled'> & {
     /**
@@ -53,9 +51,9 @@ export type LinkProps = Pick<CommonPropsLibrary, 'disabled'> & {
  *     }
  *
  * @name Link
- * @phase DesignReview
+ * @phase UXReview
  */
-function Link({ label, trailingIcon, size, variant, target = '_self', ...props }: ElementProps<LinkProps, 'a'>) {
+export function Link({ label, trailingIcon, size, variant, target = '_self', ...props }: ElementProps<LinkProps, 'a'>) {
     let LazyIcon: LazyExoticComponent<ComponentType<unknown>> | undefined = undefined;
 
     if (trailingIcon === 'external')
@@ -89,8 +87,4 @@ function Link({ label, trailingIcon, size, variant, target = '_self', ...props }
     );
 }
 
-Link.bspkName = 'Link';
-
-export { Link };
-
 /** Copyright 2025 Anywhere Real Estate - CC BY 4.0 */

package/src/components/Link/LinkExample.tsx

@@ -1,17 +1,17 @@
-import { Fragment, useId } from 'react';
+import { Fragment } from 'react';
 
+import { LinkProps, Link } from '.';
 import { Txt } from '-/components/Txt';
-import { ComponentExample } from '-/utils/demo';
+import { useId } from '-/hooks/useId';
+import { ComponentExample, Preset } from '-/utils/demo';
 
-import { LinkProps, Link } from '.';
+export const presets: Preset<LinkProps>[] = [];
 
 export const LinkExample: ComponentExample<LinkProps> = {
     containerStyle: {
         width: '100%',
     },
-    render: ({ props, preset, Component }) => {
-        if (preset?.label === 'Pseudo States') return <LinkDemo props={props} />;
-
+    render: ({ props, Component }) => {
         return (
             <div
                 style={{
@@ -26,11 +26,13 @@ export const LinkExample: ComponentExample<LinkProps> = {
             </div>
         );
     },
-    presets: [
+    sections: [
         {
-            label: 'Pseudo States',
+            title: 'Variants with Pseudo States',
+            content: ({ props }) => <LinkDemo props={props} />,
         },
     ],
+    presets,
 };
 
 /**

package/src/components/Link/link.scss

@@ -1,5 +1,5 @@
 [data-bspk='link'] {
-    display: flex;
+    display: inline-flex;
     flex-direction: row;
     align-items: center;
     gap: var(--spacing-sizing-01);

package/src/components/ListItem/ListItem.rtl.test.tsx

@@ -0,0 +1,18 @@
+import { ListItem } from './ListItem';
+import { presets } from './ListItemExample';
+import { hasNoBasicA11yIssues } from '-/rtl/hasNoBasicA11yIssues';
+import { render } from '-/rtl/util';
+
+describe('ListItem (RTL)', () => {
+    presets.forEach((preset) => {
+        it(`has no basic a11y issues - ${preset.label}`, hasNoBasicA11yIssues(<ListItem {...preset.propState} />));
+    });
+
+    it('renders', () => {
+        const { getByText } = render(<ListItem {...presets[0].propState} />);
+
+        expect(
+            getByText('This is a really long label that should be truncated if it exceeds the width of the ListItem'),
+        ).toBeInTheDocument();
+    });
+});