hisd3-ui-kit 5.3.1 → 5.5.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ThemeConfig, MenuProps, TableProps, TabsProps, ButtonProps, InputProps, SelectProps, FormItemProps, GetProps, Skeleton, Input, InputNumberProps, GetRef, InputNumber, RadioGroupProps, CheckboxProps, Checkbox, SwitchProps, DatePickerProps, DatePicker, TimePickerProps, TimePicker, TimeRangePickerProps, AutoCompleteProps, AutoComplete, MentionsProps, MentionsRef, CascaderAutoProps, Cascader, TreeSelectProps, TreeSelect, SegmentedProps, TransferProps, Transfer, Slider, RateProps, Rate, ColorPickerProps, UploadProps, UploadFile } from 'antd';
+import { ThemeConfig, MenuProps, ResultProps, TableProps, TabsProps, ButtonProps, InputProps, SelectProps, FormItemProps, GetProps, Skeleton, Input, InputNumberProps, GetRef, InputNumber, RadioGroupProps, CheckboxProps, Checkbox, SwitchProps, DatePickerProps, DatePicker, TimePickerProps, TimePicker, TimeRangePickerProps, AutoCompleteProps, AutoComplete, MentionsProps, MentionsRef, CascaderAutoProps, Cascader, TreeSelectProps, TreeSelect, SegmentedProps, TransferProps, Transfer, Slider, RateProps, Rate, ColorPickerProps, UploadProps, UploadFile } from 'antd';
 import React, { ReactNode, ComponentType } from 'react';
 import * as styled_components_dist_types from 'styled-components/dist/types';
 import * as styled_components from 'styled-components';
@@ -952,7 +952,35 @@ declare const HISD3PageBody: styled_components_dist_types.IStyledComponentBase<"
  */
 declare const HISD3PageHeader: React.FC<HISD3PageHeaderProps>;
 
-type LoginVariant = "soft" | "square";
+/** What happened to the page: it is not there, it is not for this person, or it broke. */
+type HISD3PageStatusKind = "404" | "403" | "error";
+interface HISD3PageStatusProps extends Omit<ResultProps, "status" | "icon"> {
+    /**
+     * `"404"`: the page or record does not exist. `"403"`: the person may not
+     * see it. `"error"`: it could not be loaded or shown; pair it with a Retry
+     * in `extra`.
+     */
+    status: HISD3PageStatusKind;
+}
+/**
+ * A whole-page status: a missing record, a page the person may not open, or
+ * one that failed to load. antd `Result` with one quiet icon in place of
+ * antd's coloured illustrations, which ignore the theme (a blue figure on
+ * every module, and on a dark page). The copy is the app's: `title`,
+ * `subTitle` and an `extra` with the way out, usually a primary button back
+ * to the list.
+ *
+ * ```tsx
+ * <HISD3PageStatus
+ *   status="404"
+ *   title="Folio not found"
+ *   extra={<HISD3Button variant="primary" onClick={backToList}>Back to Billing Folios</HISD3Button>}
+ * />
+ * ```
+ */
+declare function HISD3PageStatus({ status, ...rest }: HISD3PageStatusProps): react_jsx_runtime.JSX.Element;
+
+type LoginVariant = "soft" | "square" | "sheet";
 /** Which side of the screen the form card sits on. */
 type LoginSide = "left" | "right";
 
@@ -981,7 +1009,10 @@ interface HISD3LoginPageProps {
     panelTitle?: ReactNode;
     /** Supporting line under the panel headline. Pass `null` to omit it. */
     panelSubtitle?: ReactNode;
-    /** Photo behind the panel. Without one, a subtle pattern is drawn. */
+    /**
+     * Photo behind the panel. Without one, a subtle pattern is drawn ("soft",
+     * "square") or the brand illustration ("sheet").
+     */
     panelImage?: string;
     /**
      * Text beside the fixed HISD3 watermark. The watermark's mark itself is the
@@ -989,9 +1020,13 @@ interface HISD3LoginPageProps {
      */
     organisationName?: ReactNode;
     /**
-     * "soft" (rounded corners, a floating card; the default) or "square": the
+     * "soft" (rounded corners, a floating card; the default); "square": the
      * flat look of the shell — the panel edge to edge, the card with a
-     * hairline edge and no shadow, square fields and button.
+     * hairline edge and no shadow, square fields and button; or "sheet": the
+     * panel and the form side by side inside one bordered sheet on the page
+     * ground, the form standing on the sheet with no card of its own, a
+     * compact button, and the panel carrying the headline over an
+     * illustration built from the brand.
      */
     variant?: LoginVariant;
     /**
@@ -1432,5 +1467,5 @@ declare const HISD3_LAYOUT: {
     readonly panelInset: 24;
 };
 
-export { AppAnimateGroups, AppAnimates, AppMotionAnimate, AuthType, DialogProvider, Fonts, FooterType, HISD3AvatarMenu, HISD3Button, HISD3FormAutoComplete, HISD3FormCascader, HISD3FormCheckbox, HISD3FormCheckboxGroup, HISD3FormColorPicker, HISD3FormDatePicker, HISD3FormField, HISD3FormInput, HISD3FormInputNumber, HISD3FormMentions, HISD3FormOTP, HISD3FormPassword, HISD3FormRadioGroup, HISD3FormRangePicker, HISD3FormRate, HISD3FormSearch, HISD3FormSegmented, HISD3FormSelect, HISD3FormSlider, HISD3FormSwitch, HISD3FormTextArea, HISD3FormTimePicker, HISD3FormTimeRangePicker, HISD3FormTransfer, HISD3FormTreeSelect, HISD3FormUpload, HISD3FormUploadDragger, HISD3HeaderActions, HISD3Input, HISD3LoginPage, HISD3NotificationButton, HISD3PageBody, HISD3PageHeader, HISD3Provider, HISD3SearchInput, HISD3Select, HISD3SelectLabel, HISD3Sidebar, HISD3Table, HISD3Tabs, HISD3Tag, HISD3_BORDER_PRESETS, HISD3_BORDER_PRESETS_DARK, HISD3_COLORS, HISD3_FONT_FAMILY, HISD3_FONT_WEIGHT_BODY, HISD3_FONT_WEIGHT_HEADING, HISD3_LAYOUT, HISD3_LOGO_SRC, HISD3_NEUTRALS, HISD3_NEUTRALS_DARK, HISD3_PRESETS, HISD3_STATUS, HeaderIconButton, HeaderType, LayoutDirection, LayoutType, MenuStyle, MessageType, NavStyle, RoutePermittedRole, RouteTransition, ThemeMode, ThemeStyle, ThemeStyleRadius, UserMenu, borderVarsCss, contrastRatio, createHisd3Theme, getInitials, hisd3AntdTheme, hisd3VarsCss, mix, normalizeUploadFileList, resolvePrimary, resolvePrimaryPalette, shade, tint, useDialog, useInsideHISD3Provider };
-export type { DialogOwnProps, DialogProps, DialogResult, HISD3AutoCompleteRef, HISD3AvatarMenuProps, HISD3Borders, HISD3BreadcrumbItem, HISD3ButtonProps, HISD3ButtonVariant, HISD3CascaderRef, HISD3FormAutoCompleteProps, HISD3FormCascaderProps, HISD3FormCheckboxGroupProps, HISD3FormCheckboxProps, HISD3FormColorPickerProps, HISD3FormDatePickerProps, HISD3FormFieldBaseProps, HISD3FormFieldComponent, HISD3FormFieldProps, HISD3FormFieldShellProps, HISD3FormInputNumberProps, HISD3FormInputProps, HISD3FormMentionsProps, HISD3FormOTPProps, HISD3FormPasswordProps, HISD3FormRadioGroupProps, HISD3FormRangePickerProps, HISD3FormRateProps, HISD3FormSearchProps, HISD3FormSegmentedProps, HISD3FormSelectProps, HISD3FormSliderProps, HISD3FormSwitchProps, HISD3FormTextAreaProps, HISD3FormTimePickerProps, HISD3FormTimeRangePickerProps, HISD3FormTransferProps, HISD3FormTreeSelectProps, HISD3FormUploadProps, HISD3HeaderActionsProps, HISD3InputNumberRef, HISD3InputProps, HISD3LoginPageProps, HISD3LoginValues, HISD3MenuItem, HISD3Notification, HISD3NotificationButtonProps, HISD3OTPRef, HISD3PageHeaderProps, HISD3PickerRef, HISD3Preset, HISD3PrimaryPalette, HISD3ProviderProps, HISD3RangePickerRef, HISD3RateRef, HISD3SearchInputProps, HISD3SelectLabelProps, HISD3SelectOption, HISD3SelectProps, HISD3SidebarProps, HISD3SkeletonInputProps, HISD3SliderRef, HISD3TabItem, HISD3TablePagination, HISD3TableProps, HISD3TabsProps, HISD3TagProps, HISD3TagTone, HISD3TagVariant, HISD3ThemeMode, HISD3ThemeOptions, HISD3TimePickerRef, HISD3TimeRangePickerRef, HISD3TransferRef, HISD3TreeSelectRef, IUserEmployee, LoginSide, LoginVariant, StyledTheme, UserMenuProps };
+export { AppAnimateGroups, AppAnimates, AppMotionAnimate, AuthType, DialogProvider, Fonts, FooterType, HISD3AvatarMenu, HISD3Button, HISD3FormAutoComplete, HISD3FormCascader, HISD3FormCheckbox, HISD3FormCheckboxGroup, HISD3FormColorPicker, HISD3FormDatePicker, HISD3FormField, HISD3FormInput, HISD3FormInputNumber, HISD3FormMentions, HISD3FormOTP, HISD3FormPassword, HISD3FormRadioGroup, HISD3FormRangePicker, HISD3FormRate, HISD3FormSearch, HISD3FormSegmented, HISD3FormSelect, HISD3FormSlider, HISD3FormSwitch, HISD3FormTextArea, HISD3FormTimePicker, HISD3FormTimeRangePicker, HISD3FormTransfer, HISD3FormTreeSelect, HISD3FormUpload, HISD3FormUploadDragger, HISD3HeaderActions, HISD3Input, HISD3LoginPage, HISD3NotificationButton, HISD3PageBody, HISD3PageHeader, HISD3PageStatus, HISD3Provider, HISD3SearchInput, HISD3Select, HISD3SelectLabel, HISD3Sidebar, HISD3Table, HISD3Tabs, HISD3Tag, HISD3_BORDER_PRESETS, HISD3_BORDER_PRESETS_DARK, HISD3_COLORS, HISD3_FONT_FAMILY, HISD3_FONT_WEIGHT_BODY, HISD3_FONT_WEIGHT_HEADING, HISD3_LAYOUT, HISD3_LOGO_SRC, HISD3_NEUTRALS, HISD3_NEUTRALS_DARK, HISD3_PRESETS, HISD3_STATUS, HeaderIconButton, HeaderType, LayoutDirection, LayoutType, MenuStyle, MessageType, NavStyle, RoutePermittedRole, RouteTransition, ThemeMode, ThemeStyle, ThemeStyleRadius, UserMenu, borderVarsCss, contrastRatio, createHisd3Theme, getInitials, hisd3AntdTheme, hisd3VarsCss, mix, normalizeUploadFileList, resolvePrimary, resolvePrimaryPalette, shade, tint, useDialog, useInsideHISD3Provider };
+export type { DialogOwnProps, DialogProps, DialogResult, HISD3AutoCompleteRef, HISD3AvatarMenuProps, HISD3Borders, HISD3BreadcrumbItem, HISD3ButtonProps, HISD3ButtonVariant, HISD3CascaderRef, HISD3FormAutoCompleteProps, HISD3FormCascaderProps, HISD3FormCheckboxGroupProps, HISD3FormCheckboxProps, HISD3FormColorPickerProps, HISD3FormDatePickerProps, HISD3FormFieldBaseProps, HISD3FormFieldComponent, HISD3FormFieldProps, HISD3FormFieldShellProps, HISD3FormInputNumberProps, HISD3FormInputProps, HISD3FormMentionsProps, HISD3FormOTPProps, HISD3FormPasswordProps, HISD3FormRadioGroupProps, HISD3FormRangePickerProps, HISD3FormRateProps, HISD3FormSearchProps, HISD3FormSegmentedProps, HISD3FormSelectProps, HISD3FormSliderProps, HISD3FormSwitchProps, HISD3FormTextAreaProps, HISD3FormTimePickerProps, HISD3FormTimeRangePickerProps, HISD3FormTransferProps, HISD3FormTreeSelectProps, HISD3FormUploadProps, HISD3HeaderActionsProps, HISD3InputNumberRef, HISD3InputProps, HISD3LoginPageProps, HISD3LoginValues, HISD3MenuItem, HISD3Notification, HISD3NotificationButtonProps, HISD3OTPRef, HISD3PageHeaderProps, HISD3PageStatusKind, HISD3PageStatusProps, HISD3PickerRef, HISD3Preset, HISD3PrimaryPalette, HISD3ProviderProps, HISD3RangePickerRef, HISD3RateRef, HISD3SearchInputProps, HISD3SelectLabelProps, HISD3SelectOption, HISD3SelectProps, HISD3SidebarProps, HISD3SkeletonInputProps, HISD3SliderRef, HISD3TabItem, HISD3TablePagination, HISD3TableProps, HISD3TabsProps, HISD3TagProps, HISD3TagTone, HISD3TagVariant, HISD3ThemeMode, HISD3ThemeOptions, HISD3TimePickerRef, HISD3TimeRangePickerRef, HISD3TransferRef, HISD3TreeSelectRef, IUserEmployee, LoginSide, LoginVariant, StyledTheme, UserMenuProps };