@uniformdev/design-system 19.116.0 → 19.116.2-alpha.0

package/dist/index.d.mts

@@ -22986,85 +22986,151 @@ type ProgressListItem<IdType extends string = string> = {
 };
 declare const ProgressListItem: ({ children, status, error, errorLevel, autoEllipsis, }: ProgressListItemProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
+/** @deprecated beta - Filter editor component names */
 type FilterEditor = 'singleChoice' | 'multiChoice' | 'dateRange' | 'date' | 'text' | 'empty' | 'number' | 'numberRange' | 'statusMultiChoice' | 'statusSingleChoice';
+/** @deprecated beta - Input option props */
 type InputOption = {
+    /** The label for the option */
     label: string;
+    /** The value for the option */
     value?: string | undefined;
+    /** The options for the option */
     options?: Array<FilterOption>;
+    /** The operator options for the option */
     isDisabled?: boolean;
 };
+/** @deprecated beta - Operator option props */
 type Operator = {
+    /** The label for the operator */
     label: string;
+    /** The symbol for the operator */
     value?: string;
+    /** The symbol for the operator */
     symbol?: string;
+    /** The editor type for the operator */
     options?: Array<InputOption>;
+    /** The editor type for the operator */
     editorType?: FilterEditor;
 };
+/** @deprecated beta - Filter option props */
 type FilterOption = {
+    /** The label for the option */
     label: string;
+    /** The value for the option */
     value: string;
+    /** The options for the option */
     options?: FilterOption[];
+    /** The operator options for the option */
     operatorOptions?: Operator[];
+    /** The value options for the option */
     valueOptions?: InputOption[];
 };
+/** @deprecated beta - Filter selected and query value props */
 type Filter = {
+    /** The field value selected */
     field: string;
+    /** The operator value selected */
     operator: string;
+    /** The value selected */
     value: string;
 };
 
+/** @deprecated beta - a list of possible operator values that sync with uniform search api */
 type OperatorValue = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'nin' | 'between' | 'ndef' | 'def' | 'match';
 type OperatorValueType = {
     value: OperatorValue;
 };
+/** @deprecated beta - a list of possible operator types */
 type OperatorType = Array<Omit<Operator, 'value'> & OperatorValueType>;
+/** @deprecated beta - uniform number operators */
 declare const NUMBER_OPERATORS: OperatorType;
+/** @deprecated beta - uniform date operators */
 declare const DATE_OPERATORS: OperatorType;
+/** @deprecated beta - uniform textbox operators */
 declare const TEXTBOX_OPERATORS: OperatorType;
+/** @deprecated beta - uniform rich text operators */
 declare const RICHTEXT_OPERATORS: OperatorType;
+/** @deprecated beta - uniform checkbox operators */
 declare const CHECKBOX_OPERATORS: OperatorType;
+/** @deprecated beta - uniform system field operators */
 declare const SYSTEM_FIELD_OPERATORS: OperatorType;
 
+/** @description beta - filter button type */
 type FilterButtonProps = {
     text?: string;
     filterCount?: number;
 } & HTMLAttributes<HTMLButtonElement>;
+/**
+ * @deprecated beta - A filter button component used to display filter menu options
+ * @example <FilterButton text="Filters" filterCount={3} />
+ */
 declare const FilterButton: ({ text, filterCount, ...props }: FilterButtonProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
+/**
+ * @deprecated beta - Default filter controls for search and filter
+ * @example <FilterControls />
+ */
 declare const FilterControls: ({ children }: {
     children?: ReactNode;
 }) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 type FilterRowProps = {
+    /** the index of the filter row */
     index: number;
-    paramOptions: Operator[];
+    /** the list of filter options for each filter row */
+    paramOptions: FilterOption[];
+    /** function to trigger filter change events */
     onParamChange: (e: string) => void;
+    /** the list of operator options for each filter row */
     operatorOptions: Operator[];
+    /** function to trigger operator change events */
     onOperatorChange: (e: string) => void;
+    /** function to trigger value change events */
     onValueChange: (e: string) => void;
+    /** the list of value options for each filter row */
     valueOptions: InputOption[];
 };
+/** @deprecated beta - A filter item component used to display filter options */
 declare const FilterItem: ({ index, paramOptions, operatorOptions, valueOptions, onParamChange, onOperatorChange, onValueChange, }: FilterRowProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+/** @deprecated beta - A filter items component used to display filter options */
 declare const FilterItems: () => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 type SearchAndFilterOptionsContainerProps = {
+    /** The button row to be displayed at the bottom of the container */
     buttonRow?: React$1.ReactNode;
+    /** The children of the container */
     children: React$1.ReactNode;
 };
+/**
+ * @deprecated beta - A container component for search and filter options
+ * @example <SearchAndFilterOptionsContainer buttonRow={<button>Button</button>}>Children</SearchAndFilterOptionsContainer>
+ * */
 declare const SearchAndFilterOptionsContainer: ({ buttonRow, children, }: SearchAndFilterOptionsContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 type FiltersProps = {
+    /** The id of the filter menu */
     id: string;
+    /** The text for the add button */
     addButtonText?: string;
+    /** The text for the reset button */
     resetButtonText?: string;
+    /** The text for the filter title */
     filterTitle?: string;
+    /** If the add button should be disabled */
     isAddDisabled?: boolean;
+    /** The children of the filter menu */
     children: React$1.ReactNode;
 };
+/**
+ * @deprecated beta - A filter menu component used to display filter options
+ * @example <FilterMenu id="search-and-filter-options">Children</FilterMenu>
+ * */
 declare const FilterMenu: ({ id, addButtonText, isAddDisabled, resetButtonText, filterTitle, children, }: FiltersProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 type SearchAndFilterProviderProps = {
     /** sets the filter values */
     filters: Filter[];
+    /** function to trigger search change event */
+    onSearchChange: (term: string) => void;
     /** function to trigger filter change events */
     onChange: (filters: Filter[]) => void;
     /** sets the list of filter options for each filter row */
@@ -23075,7 +23141,7 @@ type SearchAndFilterProviderProps = {
 type SearchAndFilterContextProps = {
     /** the search term value */
     searchTerm: string;
-    /** sets teh search term value */
+    /** sets the search term value */
     setSearchTerm: (term: string) => void;
     /** current filter visibility */
     filterVisibility: boolean;
@@ -23097,11 +23163,18 @@ type SearchAndFilterContextProps = {
     validFilterQuery: Filter[] | undefined;
 };
 declare const SearchAndFilterContext: React$1.Context<SearchAndFilterContextProps>;
-declare const SearchAndFilterProvider: ({ filters, filterOptions, onChange, children, }: SearchAndFilterProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+/**
+ * @deprecated beta - Search and filter provider
+ * @example <SearchAndFilterProvider filters={filters} filterOptions={filterOptions} onSearchChange={onSearchChange} onChange={onChange}>Children</SearchAndFilterProvider>
+ * */
+declare const SearchAndFilterProvider: ({ filters, filterOptions, onSearchChange, onChange, children, }: SearchAndFilterProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+/** @deprecated beta - Search and filter hook
+ * @example const { searchTerm, setSearchTerm, filterVisibility, setFilterVisibility, filters, setFilters, handleAddFilter, handleResetFilters, handleDeleteFilter, filterOptions, validFilterQuery } = useSearchAndFilter();
+ */
 declare const useSearchAndFilter: () => {
     /** the search term value */
     searchTerm: string;
-    /** sets teh search term value */
+    /** sets the search term value */
     setSearchTerm: (term: string) => void;
     /** current filter visibility */
     filterVisibility: boolean;
@@ -23124,10 +23197,16 @@ declare const useSearchAndFilter: () => {
 };
 
 type SearchAndFilterProps = Omit<SearchAndFilterProviderProps, 'children'> & {
+    /** The filter controls to be displayed
+     * @default '<FilterControls />'
+     */
     filterControls?: React$1.ReactNode;
+    /** The view switch controls to be displayed */
+    viewSwitchControls?: React$1.ReactNode;
+    /** The children of the search and filter component */
     children?: React$1.ReactNode;
 };
-declare const SearchAndFilter: ({ filters, filterOptions, filterControls, children, onChange, }: SearchAndFilterProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare const SearchAndFilter: ({ filters, filterOptions, filterControls, viewSwitchControls, children, onChange, onSearchChange, }: SearchAndFilterProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 type SegmentedControlOption<TValue extends string = string> = {
     value: TValue;

package/dist/index.d.ts

@@ -22986,85 +22986,151 @@ type ProgressListItem<IdType extends string = string> = {
 };
 declare const ProgressListItem: ({ children, status, error, errorLevel, autoEllipsis, }: ProgressListItemProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
+/** @deprecated beta - Filter editor component names */
 type FilterEditor = 'singleChoice' | 'multiChoice' | 'dateRange' | 'date' | 'text' | 'empty' | 'number' | 'numberRange' | 'statusMultiChoice' | 'statusSingleChoice';
+/** @deprecated beta - Input option props */
 type InputOption = {
+    /** The label for the option */
     label: string;
+    /** The value for the option */
     value?: string | undefined;
+    /** The options for the option */
     options?: Array<FilterOption>;
+    /** The operator options for the option */
     isDisabled?: boolean;
 };
+/** @deprecated beta - Operator option props */
 type Operator = {
+    /** The label for the operator */
     label: string;
+    /** The symbol for the operator */
     value?: string;
+    /** The symbol for the operator */
     symbol?: string;
+    /** The editor type for the operator */
     options?: Array<InputOption>;
+    /** The editor type for the operator */
     editorType?: FilterEditor;
 };
+/** @deprecated beta - Filter option props */
 type FilterOption = {
+    /** The label for the option */
     label: string;
+    /** The value for the option */
     value: string;
+    /** The options for the option */
     options?: FilterOption[];
+    /** The operator options for the option */
     operatorOptions?: Operator[];
+    /** The value options for the option */
     valueOptions?: InputOption[];
 };
+/** @deprecated beta - Filter selected and query value props */
 type Filter = {
+    /** The field value selected */
     field: string;
+    /** The operator value selected */
     operator: string;
+    /** The value selected */
     value: string;
 };
 
+/** @deprecated beta - a list of possible operator values that sync with uniform search api */
 type OperatorValue = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'nin' | 'between' | 'ndef' | 'def' | 'match';
 type OperatorValueType = {
     value: OperatorValue;
 };
+/** @deprecated beta - a list of possible operator types */
 type OperatorType = Array<Omit<Operator, 'value'> & OperatorValueType>;
+/** @deprecated beta - uniform number operators */
 declare const NUMBER_OPERATORS: OperatorType;
+/** @deprecated beta - uniform date operators */
 declare const DATE_OPERATORS: OperatorType;
+/** @deprecated beta - uniform textbox operators */
 declare const TEXTBOX_OPERATORS: OperatorType;
+/** @deprecated beta - uniform rich text operators */
 declare const RICHTEXT_OPERATORS: OperatorType;
+/** @deprecated beta - uniform checkbox operators */
 declare const CHECKBOX_OPERATORS: OperatorType;
+/** @deprecated beta - uniform system field operators */
 declare const SYSTEM_FIELD_OPERATORS: OperatorType;
 
+/** @description beta - filter button type */
 type FilterButtonProps = {
     text?: string;
     filterCount?: number;
 } & HTMLAttributes<HTMLButtonElement>;
+/**
+ * @deprecated beta - A filter button component used to display filter menu options
+ * @example <FilterButton text="Filters" filterCount={3} />
+ */
 declare const FilterButton: ({ text, filterCount, ...props }: FilterButtonProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
+/**
+ * @deprecated beta - Default filter controls for search and filter
+ * @example <FilterControls />
+ */
 declare const FilterControls: ({ children }: {
     children?: ReactNode;
 }) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 type FilterRowProps = {
+    /** the index of the filter row */
     index: number;
-    paramOptions: Operator[];
+    /** the list of filter options for each filter row */
+    paramOptions: FilterOption[];
+    /** function to trigger filter change events */
     onParamChange: (e: string) => void;
+    /** the list of operator options for each filter row */
     operatorOptions: Operator[];
+    /** function to trigger operator change events */
     onOperatorChange: (e: string) => void;
+    /** function to trigger value change events */
     onValueChange: (e: string) => void;
+    /** the list of value options for each filter row */
     valueOptions: InputOption[];
 };
+/** @deprecated beta - A filter item component used to display filter options */
 declare const FilterItem: ({ index, paramOptions, operatorOptions, valueOptions, onParamChange, onOperatorChange, onValueChange, }: FilterRowProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+/** @deprecated beta - A filter items component used to display filter options */
 declare const FilterItems: () => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 type SearchAndFilterOptionsContainerProps = {
+    /** The button row to be displayed at the bottom of the container */
     buttonRow?: React$1.ReactNode;
+    /** The children of the container */
     children: React$1.ReactNode;
 };
+/**
+ * @deprecated beta - A container component for search and filter options
+ * @example <SearchAndFilterOptionsContainer buttonRow={<button>Button</button>}>Children</SearchAndFilterOptionsContainer>
+ * */
 declare const SearchAndFilterOptionsContainer: ({ buttonRow, children, }: SearchAndFilterOptionsContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 type FiltersProps = {
+    /** The id of the filter menu */
     id: string;
+    /** The text for the add button */
     addButtonText?: string;
+    /** The text for the reset button */
     resetButtonText?: string;
+    /** The text for the filter title */
     filterTitle?: string;
+    /** If the add button should be disabled */
     isAddDisabled?: boolean;
+    /** The children of the filter menu */
     children: React$1.ReactNode;
 };
+/**
+ * @deprecated beta - A filter menu component used to display filter options
+ * @example <FilterMenu id="search-and-filter-options">Children</FilterMenu>
+ * */
 declare const FilterMenu: ({ id, addButtonText, isAddDisabled, resetButtonText, filterTitle, children, }: FiltersProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 type SearchAndFilterProviderProps = {
     /** sets the filter values */
     filters: Filter[];
+    /** function to trigger search change event */
+    onSearchChange: (term: string) => void;
     /** function to trigger filter change events */
     onChange: (filters: Filter[]) => void;
     /** sets the list of filter options for each filter row */
@@ -23075,7 +23141,7 @@ type SearchAndFilterProviderProps = {
 type SearchAndFilterContextProps = {
     /** the search term value */
     searchTerm: string;
-    /** sets teh search term value */
+    /** sets the search term value */
     setSearchTerm: (term: string) => void;
     /** current filter visibility */
     filterVisibility: boolean;
@@ -23097,11 +23163,18 @@ type SearchAndFilterContextProps = {
     validFilterQuery: Filter[] | undefined;
 };
 declare const SearchAndFilterContext: React$1.Context<SearchAndFilterContextProps>;
-declare const SearchAndFilterProvider: ({ filters, filterOptions, onChange, children, }: SearchAndFilterProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+/**
+ * @deprecated beta - Search and filter provider
+ * @example <SearchAndFilterProvider filters={filters} filterOptions={filterOptions} onSearchChange={onSearchChange} onChange={onChange}>Children</SearchAndFilterProvider>
+ * */
+declare const SearchAndFilterProvider: ({ filters, filterOptions, onSearchChange, onChange, children, }: SearchAndFilterProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+/** @deprecated beta - Search and filter hook
+ * @example const { searchTerm, setSearchTerm, filterVisibility, setFilterVisibility, filters, setFilters, handleAddFilter, handleResetFilters, handleDeleteFilter, filterOptions, validFilterQuery } = useSearchAndFilter();
+ */
 declare const useSearchAndFilter: () => {
     /** the search term value */
     searchTerm: string;
-    /** sets teh search term value */
+    /** sets the search term value */
     setSearchTerm: (term: string) => void;
     /** current filter visibility */
     filterVisibility: boolean;
@@ -23124,10 +23197,16 @@ declare const useSearchAndFilter: () => {
 };
 
 type SearchAndFilterProps = Omit<SearchAndFilterProviderProps, 'children'> & {
+    /** The filter controls to be displayed
+     * @default '<FilterControls />'
+     */
     filterControls?: React$1.ReactNode;
+    /** The view switch controls to be displayed */
+    viewSwitchControls?: React$1.ReactNode;
+    /** The children of the search and filter component */
     children?: React$1.ReactNode;
 };
-declare const SearchAndFilter: ({ filters, filterOptions, filterControls, children, onChange, }: SearchAndFilterProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare const SearchAndFilter: ({ filters, filterOptions, filterControls, viewSwitchControls, children, onChange, onSearchChange, }: SearchAndFilterProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 type SegmentedControlOption<TValue extends string = string> = {
     value: TValue;