@webority/ui-react 0.88.1 → 0.90.0

package/dist/types/components/AppRadioGroup.d.ts

@@ -8,49 +8,79 @@
  * sit apart from every other field on the form.
  *
  * @param {object} props
- * @param {import('react').ReactNode} props.label Visible group label; also the group's accessible name.
+ * @param {import('react').ReactNode} props.label
  * @param {{ value: string, label: import('react').ReactNode, description?: import('react').ReactNode, disabled?: boolean }[]} props.options
- *   `description` is a muted line under the option's label, read with the radio as its description.
- * @param {string} [props.name] Shared name of the radios. Defaults to a generated one.
- * @param {string} [props.value] Selected value (controlled).
- * @param {string} [props.defaultValue] Initially selected value (uncontrolled).
+ * @param {string} [props.name]
+ * @param {string} [props.value]
+ * @param {string} [props.defaultValue]
  * @param {(value: string) => void} [props.onChange]
- * @param {'default'|'card'} [props.variant='default'] `card` draws each option as a bordered card
- *   the whole of which selects it; the chosen card takes the primary border and a tinted fill.
- * @param {boolean} [props.inline=false] Options in a row (wrapping) instead of a column.
- * @param {boolean} [props.required=false]
- * @param {boolean} [props.disabled=false] Disables every option.
- * @param {string} [props.error] Error message below the group. Replaces the hint.
- * @param {string} [props.hint] Helper text below the group.
- * @param {import('react').ReactNode} [props.help] Content for the label info-tip.
- * @param {string} [props.helpLabel="More information"] aria-label for the info-tip button.
+ * @param {'default'|'card'} [props.variant]
+ * @param {boolean} [props.inline]
+ * @param {boolean} [props.required]
+ * @param {boolean} [props.disabled]
+ * @param {string} [props.error]
+ * @param {string} [props.hint]
+ * @param {import('react').ReactNode} [props.help]
+ * @param {string} [props.helpLabel]
  * @param {string} [props.id]
- * @param {string} [props.className] Class on the group (the control).
- * @param {import('react').CSSProperties} [props.style] Inline style; lands on the group with `className`.
- * @param {string} [props.fieldClassName] Class on the `.field` wrapper.
+ * @param {string} [props.className]
+ * @param {import('react').CSSProperties} [props.style]
+ * @param {string} [props.fieldClassName]
  */
 export default function AppRadioGroup(props: {
+    /** Visible group label; also the group's accessible name. */
     label: import('react').ReactNode;
+    /** The choices, in order. Each option has a value, a label, an optional description and an optional disabled flag. */
     options: {
         value: string;
         label: import('react').ReactNode;
         description?: import('react').ReactNode;
         disabled?: boolean;
     }[];
+    /** Shared name of the radios. Defaults to a generated one. */
     name?: string;
+    /** Selected value (controlled). */
     value?: string;
+    /** Initially selected value (uncontrolled). */
     defaultValue?: string;
     onChange?: (value: string) => void;
+    /**
+     * Draws each option as a bordered card the whole of which selects it; the chosen card takes the primary border and a tinted fill.
+     * @default "default"
+     */
     variant?: 'default' | 'card';
+    /**
+     * Options in a row (wrapping) instead of a column.
+     * @default false
+     */
     inline?: boolean;
+    /**
+     * Marks the group and each option as required: the label shows the required mark, the group takes aria-required and each input the required attribute.
+     * @default false
+     */
     required?: boolean;
+    /**
+     * Disables every option.
+     * @default false
+     */
     disabled?: boolean;
+    /** Error message below the group. Replaces the hint. */
     error?: string;
+    /** Helper text below the group. */
     hint?: string;
+    /** Content for the label info-tip. */
     help?: import('react').ReactNode;
+    /**
+     * aria-label for the info-tip button.
+     * @default "More information"
+     */
     helpLabel?: string;
+    /** The group's id; generated when left out. Option ids and the label and message ids derive from it. */
     id?: string;
+    /** Class on the group (the control). */
     className?: string;
+    /** Inline style; lands on the group with className. */
     style?: import('react').CSSProperties;
+    /** Class on the .field wrapper. */
     fieldClassName?: string;
 }): import("react").JSX.Element;

package/dist/types/components/AppRating.d.ts

@@ -9,40 +9,77 @@ import "@webority/ui-elements/elements/rating";
  * let it hold its own value (`defaultValue` seeds it).
  *
  * @param {object} props
- * @param {number} [props.value] The rating (controlled as an input). A display may hold a fraction such as 4.3; an input rounds to a whole star.
- * @param {number} [props.defaultValue] Initial rating of an uncontrolled input.
+ * @param {number} [props.value]
+ * @param {number} [props.defaultValue]
  * @param {(value: number) => void} [props.onChange] Called with the chosen rating (input only).
- * @param {number} [props.max=5] How many stars.
- * @param {boolean} [props.readOnly=false] A display, not an input.
- * @param {boolean} [props.half=false] Display only: draw the value to the nearest half star.
- * @param {boolean} [props.showValue=false] Display only: print the number beside the stars.
- * @param {"sm"|"md"|"lg"} [props.size="md"]
- * @param {import('react').ReactNode} [props.label] Input: the visible group label and its name. Display: prefix of the spoken text ("Quality: 4.5 out of 5"); a string.
- * @param {string} [props.name] Input only: the form field name. Defaults to a generated one.
- * @param {boolean} [props.required=false] Input only.
- * @param {boolean} [props.disabled=false] Input only.
- * @param {string} [props.error] Input only: message below the stars. Replaces the hint.
- * @param {string} [props.hint] Input only: helper text below the stars.
+ * @param {number} [props.max]
+ * @param {boolean} [props.readOnly]
+ * @param {boolean} [props.half]
+ * @param {boolean} [props.showValue]
+ * @param {"sm"|"md"|"lg"} [props.size]
+ * @param {import('react').ReactNode} [props.label]
+ * @param {string} [props.name]
+ * @param {boolean} [props.required]
+ * @param {boolean} [props.disabled]
+ * @param {string} [props.error]
+ * @param {string} [props.hint]
  * @param {string} [props.id]
- * @param {string} [props.className] Class on the stars (the control).
- * @param {string} [props.fieldClassName] Input only: class on the `.field` wrapper.
+ * @param {string} [props.className]
+ * @param {string} [props.fieldClassName]
  */
 export default function AppRating(props: {
+    /** The rating (controlled as an input). A display may hold a fraction such as 4.3; an input rounds to a whole star. */
     value?: number;
+    /** Initial rating of an uncontrolled input. */
     defaultValue?: number;
     onChange?: (value: number) => void;
+    /**
+     * How many stars.
+     * @default 5
+     */
     max?: number;
+    /**
+     * A display, not an input.
+     * @default false
+     */
     readOnly?: boolean;
+    /**
+     * Display only: draw the value to the nearest half star.
+     * @default false
+     */
     half?: boolean;
+    /**
+     * Display only: print the number beside the stars.
+     * @default false
+     */
     showValue?: boolean;
+    /**
+     * The star size: 16, 20 or 28 pixels.
+     * @default "md"
+     */
     size?: "sm" | "md" | "lg";
+    /** Input: the visible group label and its name. Display: prefix of the spoken text, such as Quality: 4.5 out of 5; a string. */
     label?: import('react').ReactNode;
+    /** Input only: the form field name. Defaults to a generated one. */
     name?: string;
+    /**
+     * Input only: shows the required mark beside the label, and sets aria-required on the group and required on each star's input.
+     * @default false
+     */
     required?: boolean;
+    /**
+     * Input only: disables every star's input and sets the disabled attribute on the control.
+     * @default false
+     */
     disabled?: boolean;
+    /** Input only: message below the stars. Replaces the hint. */
     error?: string;
+    /** Input only: helper text below the stars. */
     hint?: string;
+    /** The rating control's id; generated when left out. */
     id?: string;
+    /** Class on the stars (the control). */
     className?: string;
+    /** Input only: class on the .field wrapper. */
     fieldClassName?: string;
 }): import("react").JSX.Element;

package/dist/types/components/AppRecordPager.d.ts

@@ -12,27 +12,43 @@ import "@webority/ui-elements/elements/record-pager";
  * `<wui-record-pager>`, which Razor `<app-record-pager>` renders too.
  *
  * @param {object} props
- * @param {number} [props.index] The position of this record, from 1. Without it (nothing open) the
- *   label is empty and both icons are disabled.
- * @param {number} [props.total] How many records the list holds.
- * @param {string} [props.prevHref] The previous record's URL.
+ * @param {number} [props.index]
+ * @param {number} [props.total]
+ * @param {string} [props.prevHref]
  * @param {(event: import('react').MouseEvent) => void} [props.onPrev] Called on previous.
- * @param {string} [props.nextHref] The next record's URL.
+ * @param {string} [props.nextHref]
  * @param {(event: import('react').MouseEvent) => void} [props.onNext] Called on next.
- * @param {string} [props.prevLabel="Previous"] The previous icon's name and tooltip ("Previous invoice").
- * @param {string} [props.nextLabel="Next"] The next icon's name and tooltip ("Next invoice").
- * @param {boolean} [props.keys=false] J and K press next and previous.
+ * @param {string} [props.prevLabel]
+ * @param {string} [props.nextLabel]
+ * @param {boolean} [props.keys]
  * @param {string} [props.className]
  */
 export default function AppRecordPager(props: {
+    /** The position of this record, from 1. Without it (nothing open) the label is empty and both icons are disabled. */
     index?: number;
+    /** How many records the list holds. */
     total?: number;
+    /** The previous record URL. */
     prevHref?: string;
     onPrev?: (event: import('react').MouseEvent) => void;
+    /** The next record URL. */
     nextHref?: string;
     onNext?: (event: import('react').MouseEvent) => void;
+    /**
+     * The previous icon name and tooltip, such as Previous invoice.
+     * @default "Previous"
+     */
     prevLabel?: string;
+    /**
+     * The next icon name and tooltip, such as Next invoice.
+     * @default "Next"
+     */
     nextLabel?: string;
+    /**
+     * J and K press next and previous.
+     * @default false
+     */
     keys?: boolean;
+    /** Extra CSS class on the pager. */
     className?: string;
 }): import("react").JSX.Element;

package/dist/types/components/AppRelativeTime.d.ts

@@ -5,14 +5,18 @@
  * `<wui-relative-time>`, which Razor `<app-relative-time>` renders too.
  *
  * @param {object} props
- * @param {string|number|Date} props.value The moment: an ISO string sent with its zone ("Z" or an
- *   offset), epoch milliseconds, or a Date. A bare "2026-10-04" is midnight IST. A missing or
- *   unreadable value shows "-" and no tooltip.
- * @param {'auto'|'top'|'bottom'|'start'|'end'} [props.tooltipPlacement='auto'] Preferred side of the exact-time tooltip.
+ * @param {string|number} props.value
+ * @param {'auto'|'top'|'bottom'|'start'|'end'} [props.tooltipPlacement]
  * @param {string} [props.className]
  */
 export default function AppRelativeTime(props: {
-    value: string | number | Date;
+    /** The moment as an ISO string with its zone (Z or an offset) or epoch milliseconds; write a Date as an ISO string. A bare 2026-10-04 is midnight IST; a missing or unreadable value shows a dash and no tooltip. */
+    value: string | number;
+    /**
+     * Preferred side of the exact-time tooltip.
+     * @default "auto"
+     */
     tooltipPlacement?: 'auto' | 'top' | 'bottom' | 'start' | 'end';
+    /** Extra class on the relative time element. */
     className?: string;
 }): any;

package/dist/types/components/AppRepeater.d.ts

@@ -20,17 +20,17 @@
  *   `<app-repeater-row label="…">`.
  * @param {() => void} props.onAdd
  * @param {(index: number) => void} [props.onRemove] Omit to make rows non-removable.
- * @param {string} [props.addLabel='Add another']
- * @param {string} [props.addVariant='secondary'] The add button's AppButton variant
- *   (primary, outline, ghost, …); an unknown value warns in dev, same as AppButton.
- * @param {string} [props.removeLabel='Remove row']
- * @param {string} [props.emptyText] Shown in place of the rows when there are none.
- * @param {number} [props.min=0] Rows at or below this count cannot be removed.
- * @param {number} [props.max] Adding is disabled at this count.
- * @param {boolean} [props.numbered=true] Show the row index.
+ * @param {string} [props.addLabel]
+ * @param {string} [props.addVariant]
+ * @param {string} [props.removeLabel]
+ * @param {string} [props.emptyText]
+ * @param {number} [props.min]
+ * @param {number} [props.max]
+ * @param {boolean} [props.numbered]
  * @param {string} [props.className]
  */
 export default function AppRepeater(props: {
+    /** The rows, one entry per row. The caller draws each row's fields. */
     rows: {
         id?: string | number;
     }[];
@@ -38,12 +38,38 @@ export default function AppRepeater(props: {
     rowLabel?: (row: object, index: number) => import('react').ReactNode;
     onAdd: () => void;
     onRemove?: (index: number) => void;
+    /**
+     * Text of the add button.
+     * @default "Add another"
+     */
     addLabel?: string;
+    /**
+     * The add button's variant, such as primary, outline or ghost. An unknown value warns in development.
+     * @default "secondary"
+     */
     addVariant?: string;
+    /**
+     * Accessible name of each remove control. The row number is added, as in "Remove row 2".
+     * @default "Remove row"
+     */
     removeLabel?: string;
+    /** Shown in place of the rows when there are none. */
     emptyText?: string;
+    /**
+     * Rows at or below this count cannot be removed.
+     * @default 0
+     */
     min?: number;
+    /** Adding is disabled at this count. */
     max?: number;
+    /**
+     * Show the row index.
+     * @default true
+     */
     numbered?: boolean;
+    /**
+     * Extra classes on the repeater.
+     * @default ""
+     */
     className?: string;
 }): import("react").JSX.Element;

package/dist/types/components/AppResizable.d.ts

@@ -13,18 +13,26 @@ export declare const ResizableDirection: import("react").Context<string>;
  * parent one. Wraps `<wui-resizable>`, which Razor `<app-resizable>` renders too.
  *
  * @param {object} props
- * @param {'horizontal'|'vertical'} [props.direction='horizontal'] `horizontal` puts the panels side by
- *   side, `vertical` stacks them.
- * @param {string} [props.storageKey] Remember the sizes under this name (one per screen).
+ * @param {'horizontal'|'vertical'} [props.direction]
+ * @param {string} [props.storageKey]
  * @param {(sizes: number[]) => void} [props.onChange] Called with every panel's size in percent after a
  *   drag, key press or reset that changed the layout, not while a drag is still moving.
  * @param {import('react').ReactNode} [props.children] `AppResizablePanel`s with an `AppResizableHandle` between each pair.
  * @param {string} [props.className]
  */
 export default function AppResizable(props: {
+    /**
+     * Horizontal puts the panels side by side, vertical stacks them. A vertical group needs a height from its parent.
+     * @default "horizontal"
+     */
     direction?: 'horizontal' | 'vertical';
+    /** Remember the sizes under this name, one per screen. */
     storageKey?: string;
     onChange?: (sizes: number[]) => void;
     children?: import('react').ReactNode;
+    /**
+     * Extra classes on the group.
+     * @default ""
+     */
     className?: string;
 }): import("react").JSX.Element;

package/dist/types/components/AppResizableHandle.d.ts

@@ -4,10 +4,18 @@
  * size and limits are announced to assistive technology.
  *
  * @param {object} props
- * @param {string} [props.label='Resize panels'] Its accessible name; say what it resizes ("Resize the list").
+ * @param {string} [props.label]
  * @param {string} [props.className]
  */
 export default function AppResizableHandle(props: {
+    /**
+     * Its accessible name. Say what it resizes, such as "Resize the list".
+     * @default "Resize panels"
+     */
     label?: string;
+    /**
+     * Extra classes on the handle.
+     * @default ""
+     */
     className?: string;
 }): import("react").JSX.Element;

package/dist/types/components/AppResizablePanel.d.ts

@@ -3,18 +3,25 @@
  * room the panels share.
  *
  * @param {object} props
- * @param {number} [props.defaultSize] The starting size in percent. Panels without one share what the sized ones leave.
- * @param {number} [props.minSize=10] The smallest the person can make it, in percent.
- * @param {number} [props.maxSize=100] The largest the person can make it, in percent.
+ * @param {number} [props.defaultSize]
+ * @param {number} [props.minSize]
+ * @param {number} [props.maxSize]
  * @param {import('react').ReactNode} [props.children]
  * @param {string} [props.className]
  * @param {import('react').CSSProperties} [props.style]
  */
 export default function AppResizablePanel(props: {
+    /** The starting size in percent. Panels without one share what the sized ones leave. */
     defaultSize?: number;
+    /** The smallest the person can make it, in percent. 10 when not set. */
     minSize?: number;
+    /** The largest the person can make it, in percent. 100 when not set. */
     maxSize?: number;
     children?: import('react').ReactNode;
+    /**
+     * Extra classes on the panel.
+     * @default ""
+     */
     className?: string;
     style?: import('react').CSSProperties;
 }): import("react").JSX.Element;

package/dist/types/components/AppResourceCard.d.ts

@@ -9,20 +9,32 @@
  * @param {object} props
  * @param {string} props.icon
  * @param {string} props.title
- * @param {string} [props.text] One line of supporting detail.
+ * @param {string} [props.text]
  * @param {string} props.href
- * @param {boolean} [props.external=false] Open in a new tab.
+ * @param {boolean} [props.external]
  * @param {import('react').ElementType} [props.linkComponent] Router link (e.g. react-router's
  *   `Link`) for an in-app destination; it receives `to` instead of `href`. Keeps the
  *   library router-agnostic.
  * @param {string} [props.className]
  */
 export default function AppResourceCard(props: {
+    /** The glyph in the tile: a library icon name. */
     icon: string;
+    /** The resource's name. It is the link text. */
     title: string;
+    /** One line of supporting detail. */
     text?: string;
+    /** Where the card links to. */
     href: string;
+    /**
+     * Open in a new tab.
+     * @default false
+     */
     external?: boolean;
     linkComponent?: import('react').ElementType;
+    /**
+     * Extra classes on the card.
+     * @default ""
+     */
     className?: string;
 }): import("react").JSX.Element;

package/dist/types/components/AppResult.d.ts

@@ -10,22 +10,38 @@
  * code as a large figure instead of an icon.
  *
  * @param {object} props
- * @param {'success'|'error'|'warning'|'info'|'403'|'404'|'500'} [props.status='info'] The outcome status.
- * @param {string} props.title The heading — what happened (required).
- * @param {import('react').ReactNode} [props.subtitle] Supporting message below the title.
- * @param {string|import('react').ReactNode} [props.icon] Override the status-default icon (name or node).
- * @param {import('react').ReactNode} [props.actions] Usually one or two AppButtons.
+ * @param {'success'|'error'|'warning'|'info'|'403'|'404'|'500'} [props.status]
+ * @param {string} props.title
+ * @param {import('react').ReactNode} [props.subtitle]
+ * @param {string|import('react').ReactNode} [props.icon]
+ * @param {import('react').ReactNode} [props.actions]
  * @param {import('react').ReactNode} [props.children] Extra content below the actions.
- * @param {1|2|3} [props.headingLevel=2] The title's heading level: 1 when the result is the whole page.
- * @param {string} [props.className] Extra classes on the result container.
+ * @param {1|2|3} [props.headingLevel]
+ * @param {string} [props.className]
  */
 export default function AppResult(props: {
+    /**
+     * The outcome. It picks the default icon and tone; 403, 404 and 500 show the code as a large figure instead of an icon.
+     * @default "info"
+     */
     status?: 'success' | 'error' | 'warning' | 'info' | '403' | '404' | '500';
+    /** The heading: what happened. */
     title: string;
+    /** Supporting message below the title. */
     subtitle?: import('react').ReactNode;
+    /** Overrides the status default icon: a library icon name or any node. */
     icon?: string | import('react').ReactNode;
+    /** Usually one or two buttons. */
     actions?: import('react').ReactNode;
     children?: import('react').ReactNode;
+    /**
+     * The title's heading level: 1 when the result is the whole page.
+     * @default 2
+     */
     headingLevel?: 1 | 2 | 3;
+    /**
+     * Extra classes on the result container.
+     * @default ""
+     */
     className?: string;
 }): import("react").JSX.Element;

package/dist/types/components/AppRichText.d.ts

@@ -1,20 +1,54 @@
 declare const AppRichText: import("react").ForwardRefExoticComponent<{
+    /** The content, in `format`. */
     value?: string;
     onChange?: (value: string) => void;
+    /** What `value` is. HTML is used when it is left out. It is read when the editor mounts, so changing it remounts the editor. */
     format?: 'html' | 'markdown';
+    /** Shown while the editor is empty. */
     placeholder?: string;
+    /** Posted under this name with a form. */
     name?: string;
+    /** The visible label above the editor. A string label also names the editor for screen readers. */
     label?: import('react').ReactNode;
+    /** Message below the editor. It replaces the hint. */
     error?: string;
+    /** Helper text below the editor. */
     hint?: string;
+    /**
+     * Marks the field required; an empty editor is invalid.
+     * @default false
+     */
     required?: boolean;
+    /**
+     * Locks the editor and keeps it out of the form post.
+     * @default false
+     */
     disabled?: boolean;
+    /**
+     * Locks the editor; the value still posts.
+     * @default false
+     */
     readOnly?: boolean;
+    /** The id of the editor; the hint and error ids derive from it. Generated when omitted. */
     id?: string;
+    /** Accessible name for the editor; defaults to a string `label`. */
     ariaLabel?: string;
+    /**
+     * Class on the `<wui-rich-text>` element.
+     * @default ""
+     */
     className?: string;
+    /**
+     * Class on the wrapper field div.
+     * @default ""
+     */
     fieldClassName?: string;
+    /** Help content shown in an info tip beside the label. */
     help?: import('react').ReactNode;
+    /**
+     * Accessible name for that info tip.
+     * @default "More information"
+     */
     helpLabel?: string;
 } & import("react").RefAttributes<HTMLElement>>;
 export default AppRichText;

package/dist/types/components/AppRollingNumber.d.ts

@@ -8,20 +8,30 @@ import "@webority/ui-elements/elements/rolling-number";
  * renders too.
  *
  * @param {object} props
- * @param {number} [props.value] The figure. Without a number it shows a hyphen.
- * @param {'number'|'currency'|'percent'} [props.format="number"] `currency` is rupees (₹12,55,015);
- *   `percent` takes a ratio (0.125 is 12.5%).
- * @param {'rupees'|'paise'} [props.unit="rupees"] What `value` counts, for `currency`.
- * @param {number} [props.decimals] Fraction digits: fixed for `currency` (default 0), the most shown
- *   for `number` (default 2) and `percent` (default 1).
- * @param {number} [props.duration=600] How long the roll takes, in milliseconds.
+ * @param {number} [props.value]
+ * @param {'number'|'currency'|'percent'} [props.format]
+ * @param {'rupees'|'paise'} [props.unit]
+ * @param {number} [props.decimals]
+ * @param {number} [props.duration]
  * @param {string} [props.className]
  */
 export default function AppRollingNumber(props: {
+    /** The figure. Without a number it shows a hyphen. */
     value?: number;
+    /**
+     * How the figure is written. `currency` is rupees (₹12,55,015); `percent` takes a ratio (0.125 is 12.5%).
+     * @default "number"
+     */
     format?: 'number' | 'currency' | 'percent';
+    /** What `value` counts, for `currency`. Rupees are used when it is left out. */
     unit?: 'rupees' | 'paise';
+    /** Fraction digits: fixed for `currency` (default 0), the most shown for `number` (default 2) and `percent` (default 1). */
     decimals?: number;
+    /** How long the roll takes, in milliseconds. It is 600 when left out. */
     duration?: number;
+    /**
+     * Extra classes on the figure.
+     * @default ""
+     */
     className?: string;
 }): import("react").JSX.Element;

package/dist/types/components/AppRouteError.d.ts

@@ -13,20 +13,37 @@
  * is mounted, above it in the root error boundary.
  *
  * @param {object} props
- * @param {'error'|'stale-build'|'not-found'} [props.kind='error'] What went wrong.
- * @param {string} [props.homeHref='/'] Where "Go to the home page" leads.
+ * @param {'error'|'stale-build'|'not-found'} [props.kind]
+ * @param {string} [props.homeHref]
  * @param {() => void} [props.onRetry] What "Try again" and "Reload" do. Default: reload the page.
- * @param {import('react').ReactNode} [props.brand] Shown above the result, usually the product's logo.
- * @param {boolean} [props.fullPage=true] Fill the viewport and centre the result. Pass `false` for an error inside a page layout.
+ * @param {import('react').ReactNode} [props.brand]
+ * @param {boolean} [props.fullPage]
  * @param {import('react').ReactNode} [props.children] Extra content below the actions, such as a support link.
- * @param {string} [props.className] Extra classes on the outer container.
+ * @param {string} [props.className]
  */
 export default function AppRouteError(props: {
+    /**
+     * What went wrong. An error offers Try again and the home page, a stale build offers Reload, and a missing page offers the home page.
+     * @default "error"
+     */
     kind?: 'error' | 'stale-build' | 'not-found';
+    /**
+     * Where "Go to the home page" leads.
+     * @default "/"
+     */
     homeHref?: string;
     onRetry?: () => void;
+    /** Shown above the result, usually the product's logo. */
     brand?: import('react').ReactNode;
+    /**
+     * Fills the viewport and centres the result. Pass false for an error inside a page layout.
+     * @default true
+     */
     fullPage?: boolean;
     children?: import('react').ReactNode;
+    /**
+     * Extra classes on the outer container.
+     * @default ""
+     */
     className?: string;
 }): import("react").JSX.Element;