@wix/patterns 1.457.0 → 1.458.0

package/dist/dts-bundle/types/TagsProps.d.ts

@@ -0,0 +1,122 @@
+import { ReactElement } from 'react';
+
+/**
+ * `WixPatternsContainer` — you receive this, you don't construct it.
+ * Produced by `useWixPatternsContainer()` (also `buildWixPatternsContainer()`, `useCustomFieldsViewWidget()`).
+ */
+declare class WixPatternsContainer {
+}
+
+/**
+ * `CollectionPageState` — you receive this, you don't construct it.
+ * Produced by `useCollectionPageState()` (also `useCollectionPageContext()`).
+ */
+declare class CollectionPageState {
+}
+
+interface Tags$1 {
+    /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
+    privateTags?: TagList;
+}
+interface TagList {
+    /** List of tag IDs */
+    tagIds?: string[];
+}
+
+/**
+ * `Filter` — cut here because it has its own bundle.
+ * Look `Filter` up in the bundle index for its full shape.
+ */
+interface Filter<T> {
+}
+type FiltersMap = {
+    [key: string]: Filter<any> | undefined;
+};
+
+/**
+ * `MoreActionsItem` — cut here because it has its own bundle.
+ * Look `MoreActionsItem` up in the bundle index for its full shape.
+ */
+interface MoreActionsItem {
+}
+
+/**
+ * `BulkActionModalRenderPropParams` — cut here because it has its own bundle.
+ * Look `BulkActionModalRenderPropParams` up in the bundle index for its full shape.
+ */
+interface BulkActionModalRenderPropParams<T, F> {
+}
+
+interface AsyncBulkUpdateTagsParams<T, F extends FiltersMap> extends Pick<BulkActionModalRenderPropParams<T, F>, 'allSelected' | 'selectedValues' | 'uncheckedValues' | 'query'> {
+    assignTags: Tags$1;
+    unassignTags: Tags$1;
+}
+
+interface BulkUpdateTagsParams {
+    entityIds: string[];
+    assignTags: Tags$1;
+    unassignTags: Tags$1;
+}
+
+/**
+ * `TableColumn` — cut here because it has its own bundle.
+ * Look `TableColumn` up in the bundle index for its full shape.
+ */
+type TableColumn<T> = unknown;
+
+type TagsColumnConfig<T> = Pick<TableColumn<T>, 'hideable' | 'defaultHidden'>;
+type TagsAssignButtonConfig = {
+    isDisabled: true;
+    tooltipContent: string;
+} | {
+    isDisabled: false;
+};
+
+declare function manageTagsPageAction({ pageState, container, }: {
+    pageState: CollectionPageState;
+    container: WixPatternsContainer;
+}): MoreActionsItem;
+
+interface TagsProps<T, F extends FiltersMap> {
+    /**
+     * A string that represents the name of the entity type(for example "Orders"), will be shown on the title of the manage tags modal
+     */
+    entityTypeName: string;
+    /**
+     * Optional config for the column
+     * @param hideable When set to false, will make the column always being checked and shown
+     * @param defaultHidden  Unchecks the column by default for the first visit (not relevant when hideable=false)
+     */
+    columnConfig?: TagsColumnConfig<T>;
+    /**
+     * A callback function that gets a list of assigned and a list of unassigned tags for the selected entities in the bulk and updates the entities according to it
+     * @param assignTags The assign tags objects that need to be update in the entities
+     * @param unassignTags The unassign tags objects that need to be update in the entities
+     * @param entityIds The entities IDs that need to be updated
+     */
+    bulkUpdateTags: (params: BulkUpdateTagsParams) => Promise<unknown>;
+    /**
+     * A callback function that takes the user's current entity selection as a parameter and starts an asynchronous bulk update of the tags using asyncJobInfra
+     */
+    asyncBulkUpdateTags?: (params: AsyncBulkUpdateTagsParams<T, F>) => Promise<{
+        jobId: string;
+    }>;
+    getTags?: (item: T) => Tags$1;
+    assignButtonConfig?: TagsAssignButtonConfig;
+    /**
+     * When set to true, will disable "Manage tags" action in the page actions menu.
+     */
+    disableDefaultPageAction?: boolean;
+    /**
+     * When set to false, will hide the undo toast after bulk tag assignment. Defaults to true.
+     */
+    bulkUpdateTagsShowUndoToast?: boolean;
+}
+declare const Tags: {
+    <T, F extends FiltersMap>(props: TagsProps<T, F>): null;
+    manageTagsPageAction: typeof manageTagsPageAction;
+};
+type TagsElement<T, F extends FiltersMap> = ReactElement<TagsProps<T, F>, typeof Tags>;
+
+export { Tags };
+export type { TagsElement, TagsProps };

package/dist/dts-bundle/types/ToolbarBaseProps.d.ts

@@ -0,0 +1,100 @@
+import React, { ReactElement, JSXElementConstructor, CSSProperties } from 'react';
+import { SearchProps } from '@wix/design-system';
+
+/**
+ * `Filter` — cut here because it has its own bundle.
+ * Look `Filter` up in the bundle index for its full shape.
+ */
+interface Filter<T> {
+}
+type FiltersMap = {
+    [key: string]: Filter<any> | undefined;
+};
+
+/**
+ * `FilterProps` — cut here because it has its own bundle.
+ * Look `FilterProps` up in the bundle index for its full shape.
+ */
+interface FilterProps<V> {
+}
+
+type FilterElement<V = any> = ReactElement<FilterProps<V>, JSXElementConstructor<FilterProps<V>>>;
+
+/**
+ * `ToolbarCollectionState` — you receive this, you don't construct it.
+ * Produced by `useToolbarCollectionContext()` (also `useTableCollectionSyncProps()`, `useKanbanCollectionSyncProps()`, `useToolbarCollectionSyncProps()`).
+ */
+declare class ToolbarCollectionState<T, F> {
+}
+
+interface CollectionSearchProps extends Partial<SearchProps> {
+    onSearchChange?: (value: string) => unknown;
+    onSearchClick?: () => unknown;
+    onSearchBlur?: (value: string) => unknown;
+    visibility?: CSSProperties['visibility'];
+}
+declare const CollectionSearch: (<T, F extends FiltersMap = FiltersMap>({ onSearchChange, onSearchClick, onSearchBlur, visibility, expandable, ...rest }: CollectionSearchProps) => React.JSX.Element) & {
+    displayName: string;
+};
+
+/**
+ * `ToolbarTitleProps` — cut here because it has its own bundle.
+ * Look `ToolbarTitleProps` up in the bundle index for its full shape.
+ */
+interface ToolbarTitleProps {
+}
+
+type CollectionSearchElement = ReactElement<CollectionSearchProps, typeof CollectionSearch>;
+type ToolbarTitleElement = ReactElement<ToolbarTitleProps>;
+
+interface ToolbarBaseProps {
+    /**
+     * Displays a title at the left of a toolbar. Accepts a [ToolbarTitle](./?path=/story/features-display-toolbar--toolbartitle) component.
+     * @overrideType [ToolbarTitle](./?path=/story/features-display-toolbar--toolbartitle)
+     * @external
+     */
+    title?: ToolbarTitleElement;
+    /**
+     * Displays a search input on the right side of the table toolbar.<br> <br>
+     * Accepts a boolean or a custom React element as a parameter. When passing `false`, no search input is displayed.
+     * @default true
+     * @external
+     */
+    search?: boolean | FilterElement | CollectionSearchElement;
+    /**
+     * Indicates whether to show Table Title Bar or not.
+     * Note: if you pass `showTitleBar = false` title bar is not removed from the DOM. For better accessibility column titles should be defined as well.
+     * @default true
+     * @external
+     */
+    showTitleBar?: boolean;
+    /**
+     * A [`<ExportButton />`](./?path=/story/features-export--exportto) react element to be added to the toolbar
+     */
+    exportButton?: ReactElement;
+    /**
+     * A [`<ImportButton />`] react element to be added to the toolbar.
+     */
+    importButton?: ReactElement;
+    /**
+     * A [`<ExportModal />`](./?path=/story/features-export--exportto#CTA_is_out_of_the_table) react element to be rendered in table's context.
+     */
+    exportModal?: ReactElement;
+    /**
+     * A [`<ImportModal />`] react element to be rendered in table's context.
+     */
+    importModal?: ReactElement;
+}
+/**
+ * `ToolbarCollectionBaseProps` — cut here because it has its own bundle.
+ * Look `ToolbarCollectionBaseProps` up in the bundle index for its full shape.
+ */
+interface ToolbarCollectionBaseProps<T, F> {
+}
+interface ToolbarCollectionProps<T, F extends FiltersMap> extends ToolbarCollectionBaseProps<T, F> {
+    state: ToolbarCollectionState<T, F>;
+}
+declare function ToolbarCollection<T, F extends FiltersMap>(props: ToolbarCollectionProps<T, F>): React.JSX.Element;
+
+export { ToolbarCollection };
+export type { ToolbarBaseProps, ToolbarCollectionBaseProps, ToolbarCollectionProps };