@wix/patterns 1.475.0 → 1.477.0

package/dist/dts-bundle/components/schema/EntityPage.d.ts

@@ -0,0 +1,317 @@
+import * as React from 'react';
+import React__default, { ReactNode, ReactElement } from 'react';
+import { CardProps, IconElement, PageProps, Breadcrumbs, BadgeProps } from '@wix/design-system';
+import { FieldValues } from 'react-hook-form';
+import { cairoPageCtaClickedParams } from '@wix/bex-utils/@wix/bi-logger-os-data/v2/types';
+
+interface EntityPageSlotsProps {
+    /**
+     * An id of the container defined in the installed on a site application that contains TPA's actions.
+     */
+    containerId: string;
+    /**
+     * Applies a data-hook HTML attribute that can be used in tests.
+     */
+    dataHook?: string;
+    /**
+     * Props passed to Slots Widgets
+     */
+    [x: string]: any;
+}
+declare function _EntityPageSlots(props: EntityPageSlotsProps): React__default.JSX.Element;
+
+interface ErrorCardProps extends CardProps {
+    /**
+     * Title to display in the error state.
+     */
+    title?: string;
+    /**
+     * Subtitle to display in the error state.
+     */
+    subtitle?: string;
+    /**
+     * Action button to display in the error state.
+     */
+    action?: {
+        /**
+         * Action button text.
+         */
+        text: string;
+        /**
+         * Callback function to run when the action button is clicked.
+         */
+        onClick: () => void;
+        /**
+         * [Icon](https://www.docs.wixdesignsystem.com/?path=/story/foundations-icons--icons) to display on the action button before the text.
+         */
+        prefixIcon?: IconElement;
+    };
+}
+
+interface CardContainerProps extends CardProps {
+    /**
+     * Additional loading flag, if you need to show loader after the main entity is fetched.
+     * Also, if an error occurs on a side request (other than passed to `fetch`), you can use `error` to show the card error state.
+     * Alongside with `error` you also need to pass `errorState.onRetry` callback, which should change the `status` accordingly.
+     */
+    status?: 'idle' | 'loading' | 'error' | 'success';
+    /**
+     * Height of content while loading (not including paddings)
+     */
+    minHeight?: string;
+    /**
+     * Card Error State configuration
+     */
+    errorState?: ErrorCardProps;
+    /**
+     * Identifier of the card.
+     * If you want to open a page and auto-scroll and focus ont his card, pass in the the query params `anchor={yourCardId}`.
+     */
+    id?: string;
+}
+
+interface FormPageCardProps extends CardContainerProps {
+}
+
+interface EntityPageCardProps extends FormPageCardProps {
+}
+declare function _EntityPageCard(props: EntityPageCardProps): React__default.JSX.Element;
+declare namespace _EntityPageCard {
+    var displayName: string;
+}
+
+interface FormPageAdditionalContentProps {
+    /**
+     * Applies a data-hook HTML attribute that can be used in tests
+     */
+    dataHook?: string;
+    children?: ReactNode;
+    /**
+     * Makes the additional content sticky when scrolling
+     */
+    sticky?: boolean;
+}
+
+interface EntityPageAdditionalContentProps extends FormPageAdditionalContentProps {
+}
+declare function EntityPageAdditionalContent(props: EntityPageAdditionalContentProps): React__default.JSX.Element;
+declare namespace EntityPageAdditionalContent {
+    var displayName: string;
+}
+
+interface FormPageMainContentProps {
+    /**
+     * Applies a data-hook HTML attribute that can be used in tests
+     */
+    dataHook?: string;
+    children?: ReactNode;
+}
+
+interface EntityPageMainContentProps extends FormPageMainContentProps {
+}
+declare function EntityPageMainContent(props: EntityPageMainContentProps): React__default.JSX.Element;
+declare namespace EntityPageMainContent {
+    var displayName: string;
+}
+
+declare function useEntityPageContent(child: EntityPageContentElement, scrollableRef?: HTMLElement | null): React.JSX.Element;
+
+interface EntityPageContentProps {
+    /**
+     * <EntityPage.MainContent> and, if needed, <EntityPage.AdditionalContent> elements
+     */
+    children: ReactNode;
+}
+type EntityPageContentElement = ReactElement<EntityPageContentProps, typeof EntityPageContent>;
+declare function EntityPageContent(_props: EntityPageContentProps): null;
+declare namespace EntityPageContent {
+    var useEntityPageContent: typeof useEntityPageContent;
+    var displayName: string;
+}
+
+/**
+ * `WixPatternsContainer` — you receive this, you don't construct it.
+ * Produced by `useWixPatternsContainer()` (also `buildWixPatternsContainer()`, `useCustomFieldsViewWidget()`).
+ */
+declare class WixPatternsContainer {
+    [key: string]: unknown;
+}
+
+/**
+ * `CollectionPageState` — you receive this, you don't construct it.
+ * Produced by `useCollectionPageState()` (also `useCollectionPageContext()`).
+ */
+declare class CollectionPageState {
+    [key: string]: unknown;
+}
+
+type SaveCtaText = 'PUBLISH' | 'APPLY' | 'CONNECT' | 'ACTIVATE' | 'SAVE' | 'SUBMIT';
+interface SaveCtaSecondaryAction {
+    consumerText: string;
+    onClick: () => void;
+    icon?: ReactNode;
+    disabled?: boolean;
+    dataHook?: string;
+}
+interface ActionsBarConfig {
+    saveCta?: {
+        text?: SaveCtaText;
+        consumerText?: string;
+        biAdditionalInfo?: cairoPageCtaClickedParams['additionalInfo'];
+        /** Puts these behind a chevron on the save CTA. Not rendered on mobile, where a split action cannot be full-width. */
+        secondaryActions?: SaveCtaSecondaryAction[];
+    };
+    cancelCta?: {
+        biAdditionalInfo?: cairoPageCtaClickedParams['additionalInfo'];
+    };
+}
+
+interface ExploreAppsModalProps {
+    title: string;
+    subtitle: string;
+    tag: string;
+}
+
+/**
+ * `MoreActionsItem` — cut here because it has its own bundle.
+ * Full shape: `types/MoreActionsItem.d.ts`.
+ */
+interface MoreActionsItem {
+    [key: string]: unknown;
+}
+
+type MoreActionItemFactory = (params: {
+    pageState: CollectionPageState;
+    container: WixPatternsContainer;
+}) => MoreActionsItem;
+type MoreActionsPropItem = MoreActionsItem | MoreActionItemFactory;
+
+interface MoreActionsProps {
+    /**
+     * Actions items that appear in the `MoreActions` popover menu. \
+     * Actions can be grouped by using an array of arrays. \
+     * Each sub-array represents a different group within the popover, \
+     * and a divider will be rendered after each sub-array to separate the groups.
+     * @overrideType [MoreActionsItem](./?path=/story/common-types--moreactionsitem)[] | [MoreActionsItem](./?path=/story/common-types--moreactionsitem)[][]
+     * @external
+     */
+    items?: MoreActionsPropItem[] | MoreActionsPropItem[][];
+    /**
+     * An id of the container defined in the installed on a site application that contains TPA's actions.
+     */
+    containerId?: string;
+    /**
+     * Additional properties passed to the `onClick` of the container's extensions menu items.
+     */
+    containerProps?: Record<string, any>;
+    /**
+     * Additional info for cairoPageCtaClicked BI event.
+     */
+    biAdditionalInfo?: string;
+    dataHook?: string;
+    exploreAppsModalProps?: ExploreAppsModalProps;
+}
+
+interface MoreActionsIconProps extends MoreActionsProps {
+}
+declare function _MoreActionsIcon(params: MoreActionsIconProps): React__default.JSX.Element;
+declare const MoreActionsIcon: typeof _MoreActionsIcon & {
+    displayName: string;
+};
+
+type MoreActionsElement = ReactElement<MoreActionsProps, typeof MoreActionsIcon>;
+
+interface EntityPageProps<T, V extends FieldValues = FieldValues> extends PageProps {
+    /**
+     * EntityPageState instance created with the `useEntityPage` hook
+     */
+    state: EntityPageState<T, V>;
+    /**
+     * Configuration for the actions bar
+     */
+    actionsBarConfig?: ActionsBarConfig;
+}
+
+/**
+ * Props for the PageSubTitle component.
+ * @property {string} text The subtitle text.
+ * @property {Object} [learnMore] An object with a `url` (required) for displaying a link button on the subtitle.
+ * @property {string} learnMore.url where the link should navigate to
+ * @property {string} [learnMore.label ="Learn more"] - the label of the link button. defaults to "Learn More"
+ */
+interface PageSubTitleProps {
+    text: string;
+    learnMore?: {
+        url: string;
+        label?: string;
+    };
+}
+
+interface FormPageHeaderProps {
+    /**
+     * <MoreActions />
+     */
+    moreActions?: MoreActionsElement;
+    /**
+     * Page breadcrumbs
+     */
+    breadcrumbs?: ReactElement<Breadcrumbs>;
+    /**
+     * Page title text and optional badges
+     */
+    title: {
+        text: string;
+        badges?: (Pick<BadgeProps, 'skin' | 'type' | 'prefixIcon' | 'suffixIcon'> & {
+            text: string;
+        })[];
+    };
+    /**
+     * Page subtitle text
+     */
+    subtitle?: PageSubTitleProps;
+}
+
+/**
+ * `EntityPageState` — you receive this, you don't construct it.
+ * Produced by `useEntityPage()` (also `useEntityPageContext()`). Its own API is in `types/EntityPageState.d.ts`.
+ */
+declare class EntityPageState<T = any, V = any> {
+    [key: string]: unknown;
+}
+
+declare function useEntityPageHeader(child: EntityPageHeaderElement): React__default.JSX.Element;
+
+interface EntityPageHeaderProps extends FormPageHeaderProps {
+}
+type EntityPageHeaderElement = ReactElement<EntityPageHeaderProps, typeof EntityPageHeader>;
+declare function EntityPageHeader(_props: EntityPageHeaderProps): null;
+declare namespace EntityPageHeader {
+    var useEntityPageHeader: typeof useEntityPageHeader;
+    var displayName: string;
+}
+
+/** EntityPage props for a source-driven page — the same as the open component's.
+ *  The fields container the page's fields need is wired here, not by the
+ *  consumer. */
+type SchemaEntityPageProps<T, V extends FieldValues = FieldValues> = EntityPageProps<T, V>;
+declare function _EntityPage<T, V extends FieldValues = FieldValues>({ state, ...rest }: SchemaEntityPageProps<T, V>): React__default.JSX.Element;
+declare namespace _EntityPage {
+    var Header: typeof EntityPageHeader;
+    var Content: typeof EntityPageContent;
+    var MainContent: typeof EntityPageMainContent;
+    var AdditionalContent: typeof EntityPageAdditionalContent;
+    var Card: typeof _EntityPageCard & {
+        displayName: string;
+    };
+    var Slots: typeof _EntityPageSlots & {
+        displayName: string;
+    };
+    var Extensions: typeof _EntityPageSlots & {
+        displayName: string;
+    };
+    var displayName: string;
+}
+declare const EntityPage: typeof _EntityPage;
+
+export { EntityPage };
+export type { SchemaEntityPageProps };