@nxgt/material 3.70.0 → 3.72.0

package/dist/lib/components/ui/fields/attributes/attribute-values-form-field-set/attribute-values-form-field-set.d.ts

@@ -3,10 +3,14 @@ import { Control, Path } from 'react-hook-form';
 import { Attribute } from '../models/attribute.js';
 export interface AttributeValuesFormFieldSetProps<T extends Record<string, any>> {
     attributes: Attribute[];
+    /** Used only while the form value at `name` is empty (undefined, null or `{}`). */
     defaultValues?: Record<string, any>;
     control: Control<T>;
     name: Path<T>;
     className?: string;
+    /** The set's accessible name; drawn as a heading unless `hideLabel`. */
     label: ReactNode;
+    /** Keep `label` as the group's accessible name but draw nothing, e.g. under a `FormSection` that already titles it. */
+    hideLabel?: boolean;
 }
-export declare function AttributeValuesFormFieldSet<T extends Record<string, Attribute>>({ attributes, defaultValues, name, control, label, className, }: AttributeValuesFormFieldSetProps<T>): import("react").JSX.Element;
+export declare function AttributeValuesFormFieldSet<T extends Record<string, Attribute>>({ attributes, defaultValues, name, control, label, hideLabel, className, }: AttributeValuesFormFieldSetProps<T>): import("react").JSX.Element;

package/dist/lib/components/ui/fields/contacts/contact-dialog.d.ts

@@ -1,13 +1,19 @@
 import { ButtonVariant } from '../../actions/button/button.js';
-import { Contact } from './models.js';
+import { Contact, ContactTypeName } from './models.js';
 export type ContactDialogProps = {
     open: boolean;
     onOpenChange: (open: boolean) => void;
     contact?: Contact | null;
     onSave: (contact: Contact) => void;
     onDelete?: () => void;
+    /**
+     * The contact types offered by the type select, in the order given; every
+     * type by default. A new contact starts with the first one, and an edited
+     * contact keeps its own type in the list.
+     */
+    types?: readonly ContactTypeName[];
     disabled?: boolean;
     /** The Cancel button's variant. Default `'tonal'`; `'outlined'` restores the earlier look. */
     cancelVariant?: ButtonVariant;
 };
-export declare function ContactDialog({ open, onOpenChange, contact, onSave, onDelete, disabled, cancelVariant, }: ContactDialogProps): import("react").JSX.Element;
+export declare function ContactDialog({ open, onOpenChange, contact, onSave, onDelete, types, disabled, cancelVariant, }: ContactDialogProps): import("react").JSX.Element;

package/dist/lib/components/ui/fields/contacts/contacts-dialog-form-field.d.ts

@@ -1,12 +1,15 @@
 import { ComponentProps } from 'react';
 import { UseControllerProps } from 'react-hook-form';
 import { ButtonVariant } from '../../actions/button/button.js';
+import { ContactTypeName } from './models.js';
 export type ContactsDialogFieldProps<T extends Record<string, any>> = Pick<UseControllerProps<T>, 'control' | 'name'> & {
     className?: string;
     disabled?: boolean;
     label?: string;
+    /** The contact types the dialog offers; every type by default. */
+    types?: readonly ContactTypeName[];
     /** The dialog's Cancel button variant. Default `'tonal'`; `'outlined'` restores the earlier look. */
     cancelVariant?: ButtonVariant;
 } & Omit<ComponentProps<'div'>, 'name'>;
 /** `ContactsFormField` with `editing="dialog"`: a list, and a dialog per contact. */
-export declare function ContactsDialogField<T extends Record<string, any>>({ control, name, className, disabled, label, cancelVariant, ...props }: ContactsDialogFieldProps<T>): import("react").JSX.Element;
+export declare function ContactsDialogField<T extends Record<string, any>>({ control, name, className, disabled, label, types, cancelVariant, ...props }: ContactsDialogFieldProps<T>): import("react").JSX.Element;

package/dist/lib/components/ui/fields/contacts/contacts-editor.d.ts

@@ -1,6 +1,6 @@
 import { ReactNode } from 'react';
 import { HeadingLevel } from '../inline-editor/editor-header.js';
-import { Contact } from './models.js';
+import { Contact, ContactTypeName } from './models.js';
 export type ContactsEditorProps = {
     value?: Contact[];
     onValueChange?: (value: Contact[]) => void;
@@ -14,6 +14,19 @@ export type ContactsEditorProps = {
      * the primary one. The fields keep the library's field radius in both.
      */
     variant?: 'list' | 'cards';
+    /**
+     * The contact types offered by the "Add" chips and the type menu, in the
+     * order given for the menu; every type by default. A contact already in
+     * the value with another type is kept and shown, and its type stays in
+     * its own menu so nothing is changed silently.
+     */
+    types?: readonly ContactTypeName[];
+    /**
+     * Whether contacts can be marked primary (the star); `true` by default.
+     * `false` hides the star and the primary marks; a `primary` flag already
+     * in the value is left untouched.
+     */
+    primary?: boolean;
     disabled?: boolean;
     className?: string;
 };
@@ -26,4 +39,4 @@ export type ContactsEditorProps = {
  * row that opens a bottom sheet with the same fields. It holds the value model
  * of `Contacts` (`primary` is an optional addition).
  */
-export declare function ContactsEditor({ value, onValueChange, label, headingLevel, variant, disabled, className, }: ContactsEditorProps): import("react").JSX.Element;
+export declare function ContactsEditor({ value, onValueChange, label, headingLevel, variant, types, primary, disabled, className, }: ContactsEditorProps): import("react").JSX.Element;

package/dist/lib/components/ui/fields/contacts/contacts-form-field.d.ts

@@ -1,6 +1,7 @@
 import { ComponentProps } from 'react';
 import { UseControllerProps } from 'react-hook-form';
 import { ButtonVariant } from '../../actions/button/button.js';
+import { ContactTypeName } from './models.js';
 export type ContactsFormFieldProps<T extends Record<string, any>> = Pick<UseControllerProps<T>, 'control' | 'name'> & {
     className?: string;
     disabled?: boolean;
@@ -13,6 +14,10 @@ export type ContactsFormFieldProps<T extends Record<string, any>> = Pick<UseCont
     editing?: 'inline' | 'dialog';
     /** `editing="inline"` only: `'list'` (default) or `'cards'`. */
     variant?: 'list' | 'cards';
+    /** The contact types offered, e.g. `['EMAIL', 'PHONE']`; every type by default. */
+    types?: readonly ContactTypeName[];
+    /** `editing="inline"` only (the dialog has no star): `false` hides the primary star and marks; `true` by default. */
+    primary?: boolean;
     /** `editing="dialog"` only: the dialog's Cancel button variant. Default `'tonal'`. */
     cancelVariant?: ButtonVariant;
 } & Omit<ComponentProps<'div'>, 'name'>;
@@ -21,4 +26,4 @@ export type ContactsFormFieldProps<T extends Record<string, any>> = Pick<UseCont
  * primary? }`). Inline by default; `editing="dialog"` is today's list and
  * dialog.
  */
-export declare function ContactsFormField<T extends Record<string, any>>({ editing, variant, cancelVariant, ...props }: ContactsFormFieldProps<T>): import("react").JSX.Element;
+export declare function ContactsFormField<T extends Record<string, any>>({ editing, variant, types, primary, cancelVariant, ...props }: ContactsFormFieldProps<T>): import("react").JSX.Element;

package/dist/lib/components/ui/fields/contacts/logic/offered-types.d.ts

@@ -0,0 +1,3 @@
+import { ContactType, ContactTypeName } from '../models.js';
+/** The menu's types: those offered, plus the contact's own when it is another. */
+export declare function offeredTypes(types: readonly ContactTypeName[] | undefined, current?: ContactType): ContactType[];

package/dist/lib/components/ui/fields/contacts/models.d.ts

@@ -30,3 +30,5 @@ export type ContactFieldValue = {
     label?: string;
     primary?: boolean;
 };
+/** A contact type as the enum or its string value: `ContactType.Email` or `'EMAIL'`. */
+export type ContactTypeName = `${ContactType}`;

package/dist/lib/components/ui/fields/contacts/partials/contact-fields.d.ts

@@ -1,4 +1,4 @@
-import { Contact } from '../models.js';
+import { Contact, ContactTypeName } from '../models.js';
 import { ContactText } from '../use-contact-text.js';
 type ContactFieldsProps = {
     text: ContactText;
@@ -15,6 +15,8 @@ type ContactFieldsProps = {
     focusKey: (name: string) => string;
     /** Each contact's place in its type's group, 1-based: the accessible names. */
     positions: ReadonlyMap<number, number>;
+    /** The types offered by the menu; every type by default. */
+    types?: readonly ContactTypeName[];
     disabled?: boolean;
     /** One column: the sheet's layout. */
     stacked?: boolean;
@@ -25,5 +27,5 @@ type ContactFieldsProps = {
  * belong to the value: a wrong format, a duplicate or, once left, an empty
  * value. Each message is a `role="alert"` linked to the value field.
  */
-export declare function ContactFields({ text, contact, index, items, rowId, left, onLeave, focusKey, positions, disabled, stacked, onChange, }: ContactFieldsProps): import("react").JSX.Element;
+export declare function ContactFields({ text, contact, index, items, rowId, left, onLeave, focusKey, positions, types, disabled, stacked, onChange, }: ContactFieldsProps): import("react").JSX.Element;
 export {};

package/dist/lib/components/ui/fields/contacts/partials/contact-groups.d.ts

@@ -1,6 +1,6 @@
 import { HeadingLevel } from '../../inline-editor/editor-header.js';
 import { groupContacts } from '../logic/primary.js';
-import { Contact } from '../models.js';
+import { Contact, ContactTypeName } from '../models.js';
 import { ContactText } from '../use-contact-text.js';
 import { ContactsEditorState } from '../use-contacts-editor.js';
 type ContactGroupsProps = {
@@ -13,8 +13,10 @@ type ContactGroupsProps = {
     headingLevel?: HeadingLevel;
     /** A phone shows summary rows that open the sheet. */
     phone: boolean;
+    types?: readonly ContactTypeName[];
+    primary?: boolean;
     disabled?: boolean;
 };
 /** The contacts of each type: full rows, or on a phone summary rows. */
-export declare function ContactGroups({ text, editor, items, groups, positions, variant, headingLevel, phone, disabled, }: ContactGroupsProps): import("react").JSX.Element[];
+export declare function ContactGroups({ text, editor, items, groups, positions, variant, headingLevel, phone, types, primary, disabled, }: ContactGroupsProps): import("react").JSX.Element[];
 export {};

package/dist/lib/components/ui/fields/contacts/partials/contact-row.d.ts

@@ -1,4 +1,4 @@
-import { Contact } from '../models.js';
+import { Contact, ContactTypeName } from '../models.js';
 import { ContactText } from '../use-contact-text.js';
 import { ContactsEditorState } from '../use-contacts-editor.js';
 export type ContactRowProps = {
@@ -8,7 +8,9 @@ export type ContactRowProps = {
     index: number;
     positions: ReadonlyMap<number, number>;
     variant: 'list' | 'cards';
+    types?: readonly ContactTypeName[];
+    primary?: boolean;
     disabled?: boolean;
 };
 /** One contact on a tablet or a desktop: its icon, its fields and its actions. */
-export declare function ContactRow({ text, editor, items, index, positions, variant, disabled, }: ContactRowProps): import("react").JSX.Element;
+export declare function ContactRow({ text, editor, items, index, positions, variant, types, primary: withPrimary, disabled, }: ContactRowProps): import("react").JSX.Element;

package/dist/lib/components/ui/fields/contacts/partials/phone-sheet.d.ts

@@ -1,4 +1,4 @@
-import { Contact } from '../models.js';
+import { Contact, ContactTypeName } from '../models.js';
 import { ContactText } from '../use-contact-text.js';
 import { ContactsEditorState } from '../use-contacts-editor.js';
 type PhoneSheetProps = {
@@ -7,8 +7,10 @@ type PhoneSheetProps = {
     items: Contact[];
     positions: ReadonlyMap<number, number>;
     variant: 'list' | 'cards';
+    types?: readonly ContactTypeName[];
+    primary?: boolean;
     disabled?: boolean;
 };
 /** A phone's editor for one contact: the same fields and actions, in a bottom sheet. */
-export declare function PhoneSheet({ text, editor, items, positions, variant, disabled, }: PhoneSheetProps): import("react").JSX.Element;
+export declare function PhoneSheet({ text, editor, items, positions, variant, types, primary, disabled, }: PhoneSheetProps): import("react").JSX.Element;
 export {};

package/dist/lib/components/ui/fields/contacts/partials/quick-add.d.ts

@@ -1,12 +1,14 @@
-import { ContactType } from '../models.js';
+import { ContactType, ContactTypeName } from '../models.js';
 import { ContactText } from '../use-contact-text.js';
 type QuickAddProps = {
     text: ContactText;
+    /** The types offered; every type by default. */
+    types?: readonly ContactTypeName[];
     disabled?: boolean;
     /** The scoped focus key of a control, so a remove can return to the chip. */
     focusKey: (name: string) => string;
     onAdd: (type: ContactType) => void;
 };
 /** "Add Contact" and one chip per type: adds an empty contact of that type. */
-export declare function QuickAdd({ text: { t, typeName }, disabled, focusKey, onAdd, }: QuickAddProps): import("react").JSX.Element;
+export declare function QuickAdd({ text: { t, typeName }, types, disabled, focusKey, onAdd, }: QuickAddProps): import("react").JSX.Element;
 export {};

package/dist/lib/components/ui/fields/contacts/partials/row-actions.d.ts

@@ -7,10 +7,12 @@ type RowActionsProps = {
     position: number;
     /** The star's scoped focus key, so focus can return to it after the row moves. */
     starFocusKey?: string;
+    /** Hides the star (primary marks are off). */
+    hidePrimary?: boolean;
     disabled?: boolean;
     onPrimary: () => void;
     onRemove: () => void;
 };
 /** The star that makes a contact the primary one of its type, and the trash. */
-export declare function RowActions({ text: { t }, primary, typeName, position, starFocusKey, disabled, onPrimary, onRemove, }: RowActionsProps): import("react").JSX.Element;
+export declare function RowActions({ text: { t }, primary, typeName, position, starFocusKey, hidePrimary, disabled, onPrimary, onRemove, }: RowActionsProps): import("react").JSX.Element;
 export {};