@uniformdev/design-system 19.141.1-alpha.5 → 19.142.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/index.js +9214 -10775
- package/dist/index.d.mts +26 -423
- package/dist/index.d.ts +26 -423
- package/dist/index.js +9865 -11461
- package/package.json +4 -4
package/dist/index.d.mts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import * as _emotion_react_types_jsx_namespace from '@emotion/react/types/jsx-namespace';
|
|
2
|
+
import { DecoratorFn } from '@storybook/react';
|
|
2
3
|
import * as React$1 from 'react';
|
|
3
|
-
import React__default, { RefObject, HTMLAttributes, ReactNode, ImgHTMLAttributes, SVGProps, CSSProperties, ButtonHTMLAttributes, FocusEventHandler, ChangeEvent,
|
|
4
|
+
import React__default, { RefObject, HTMLAttributes, ReactNode, ImgHTMLAttributes, SVGProps, CSSProperties, ButtonHTMLAttributes, FocusEventHandler, ChangeEvent, HtmlHTMLAttributes } from 'react';
|
|
4
5
|
import { GroupBase, Props } from 'react-select';
|
|
5
6
|
export { ActionMeta, FormatOptionLabelContext, FormatOptionLabelMeta, GetOptionLabel, GetOptionValue, GroupBase, GroupHeadingProps, GroupProps, MenuListProps, MenuPlacement, MultiValue, MultiValueGenericProps, MultiValueProps, MultiValueRemoveProps, OnChangeValue, OptionContext, OptionProps, Options, OptionsOrGroups } from 'react-select';
|
|
6
7
|
import * as _emotion_react from '@emotion/react';
|
|
@@ -44,6 +45,8 @@ type ThemeProps = {
|
|
|
44
45
|
* @example <Theme disableReset={true} /> */
|
|
45
46
|
declare const Theme: ({ disableReset, disableGlobalReset }: ThemeProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
46
47
|
|
|
48
|
+
declare const BetaDecorator: DecoratorFn;
|
|
49
|
+
|
|
47
50
|
/** Breakpoint label values */
|
|
48
51
|
type BreakpointSize = 'sm' | 'md' | 'lg' | 'xl' | '2xl';
|
|
49
52
|
type BreakpointsMap = Record<BreakpointSize, number>;
|
|
@@ -21639,6 +21642,24 @@ type ErrorMessageProps = {
|
|
|
21639
21642
|
*/
|
|
21640
21643
|
declare const ErrorMessage: ({ message, testId, truncated, ...otherProps }: ErrorMessageProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
|
|
21641
21644
|
|
|
21645
|
+
type FieldMessageProps = {
|
|
21646
|
+
/** (optional) sets help message within the caption component */
|
|
21647
|
+
helperMessage?: string | JSX.Element;
|
|
21648
|
+
/** (option) sets caption message test id for test automation */
|
|
21649
|
+
helperMessageTestId?: string;
|
|
21650
|
+
/** (optional) sets and shows the warning message value */
|
|
21651
|
+
warningMessage?: string;
|
|
21652
|
+
/** (option) sets warning message test id for test automation */
|
|
21653
|
+
warningMessageTestId?: string;
|
|
21654
|
+
/** (optional) sets and shows the the error message value */
|
|
21655
|
+
errorMessage?: string;
|
|
21656
|
+
/** (option) sets validation message test id for test automation */
|
|
21657
|
+
errorTestId?: string;
|
|
21658
|
+
/** (optional) sets and shows the the info message value */
|
|
21659
|
+
infoMessage?: string;
|
|
21660
|
+
};
|
|
21661
|
+
declare const FieldMessage: ({ helperMessage, warningMessage, errorMessage, infoMessage, errorTestId, helperMessageTestId, }: FieldMessageProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
|
|
21662
|
+
|
|
21642
21663
|
type FieldsetProps = React$1.HTMLAttributes<HTMLFieldSetElement> & {
|
|
21643
21664
|
/** sets the legend value */
|
|
21644
21665
|
legend: React$1.ReactElement;
|
|
@@ -22607,6 +22628,9 @@ type ParameterDrawerHeaderProps = {
|
|
|
22607
22628
|
iconBeforeTitle?: ReactNode;
|
|
22608
22629
|
children?: ReactNode;
|
|
22609
22630
|
};
|
|
22631
|
+
/**
|
|
22632
|
+
* @deprecated use <Drawer heading={"Hi!"} /> instead, to use default drawer heading styles
|
|
22633
|
+
*/
|
|
22610
22634
|
declare const ParameterDrawerHeader: ({ title, iconBeforeTitle, children }: ParameterDrawerHeaderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
22611
22635
|
|
|
22612
22636
|
type ParameterGroupProps = React.HTMLAttributes<HTMLFieldSetElement> & {
|
|
@@ -23012,427 +23036,6 @@ type ProgressListItem<IdType extends string = string> = {
|
|
|
23012
23036
|
};
|
|
23013
23037
|
declare const ProgressListItem: ({ children, status, error, errorLevel, autoEllipsis, }: ProgressListItemProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23014
23038
|
|
|
23015
|
-
/** @deprecated beta - Filter editor component names */
|
|
23016
|
-
type FilterEditor = 'singleChoice' | 'multiChoice' | 'dateRange' | 'date' | 'text' | 'empty' | 'number' | 'numberRange' | 'statusMultiChoice' | 'statusSingleChoice';
|
|
23017
|
-
/** @deprecated beta - Input option props */
|
|
23018
|
-
type InputOption = {
|
|
23019
|
-
/** The label for the option */
|
|
23020
|
-
label: string;
|
|
23021
|
-
/** The value for the option */
|
|
23022
|
-
value?: string | undefined;
|
|
23023
|
-
/** The options for the option */
|
|
23024
|
-
options?: Array<FilterOption>;
|
|
23025
|
-
/** Set a disabled state on the input */
|
|
23026
|
-
isDisabled?: boolean;
|
|
23027
|
-
/** Set a readonly state on the input */
|
|
23028
|
-
readOnly?: boolean;
|
|
23029
|
-
};
|
|
23030
|
-
/** @deprecated beta - Operator option props */
|
|
23031
|
-
type Operator = {
|
|
23032
|
-
/** The label for the operator */
|
|
23033
|
-
label: string;
|
|
23034
|
-
/** The symbol for the operator */
|
|
23035
|
-
value?: string;
|
|
23036
|
-
/** The symbol for the operator */
|
|
23037
|
-
symbol?: string;
|
|
23038
|
-
/** The editor type for the operator */
|
|
23039
|
-
options?: Array<InputOption>;
|
|
23040
|
-
/** The editor type for the operator */
|
|
23041
|
-
editorType?: FilterEditor;
|
|
23042
|
-
};
|
|
23043
|
-
/** @deprecated beta - Filter option props */
|
|
23044
|
-
type FilterOption = {
|
|
23045
|
-
/** The label for the option */
|
|
23046
|
-
label: string;
|
|
23047
|
-
/** The value for the option */
|
|
23048
|
-
value: string;
|
|
23049
|
-
/** The options for the option */
|
|
23050
|
-
options?: FilterOption[];
|
|
23051
|
-
/** The operator options for the option */
|
|
23052
|
-
operatorOptions?: Operator[];
|
|
23053
|
-
/** The value options for the option */
|
|
23054
|
-
valueOptions?: InputOption[];
|
|
23055
|
-
/** Set a readonly state on the input */
|
|
23056
|
-
readOnly?: boolean;
|
|
23057
|
-
/** Set a disabled state on the input */
|
|
23058
|
-
disabled?: boolean;
|
|
23059
|
-
/** If filter operator allows it allow bind dynamic value to this filter */
|
|
23060
|
-
bindable?: boolean;
|
|
23061
|
-
};
|
|
23062
|
-
/** @deprecated beta - Filter selected and query value props */
|
|
23063
|
-
type Filter = {
|
|
23064
|
-
/** The field value selected */
|
|
23065
|
-
field: string;
|
|
23066
|
-
/** The operator value selected */
|
|
23067
|
-
operator: string;
|
|
23068
|
-
/** The value selected */
|
|
23069
|
-
value: string | string[];
|
|
23070
|
-
};
|
|
23071
|
-
|
|
23072
|
-
/** @deprecated beta - a list of possible operator values that sync with uniform search api */
|
|
23073
|
-
type OperatorValue = 'eq' | 'sys-date-eq' | 'neq' | 'sys-date-neq' | 'gt' | 'sys-date-gt' | 'gte' | 'sys-date-gte' | 'lt' | 'sys-date-lt' | 'lte' | 'sys-date-lte' | 'in' | 'nin' | 'between' | 'sys-date-between' | 'ndef' | 'def' | 'match' | 'starts';
|
|
23074
|
-
type OperatorValueType = {
|
|
23075
|
-
value: OperatorValue;
|
|
23076
|
-
};
|
|
23077
|
-
/** @deprecated beta - a list of possible operator types */
|
|
23078
|
-
type OperatorType = Array<Omit<Operator, 'value'> & OperatorValueType>;
|
|
23079
|
-
/** @deprecated beta - uniform number operators */
|
|
23080
|
-
declare const NUMBER_OPERATORS: OperatorType;
|
|
23081
|
-
/** @deprecated beta - uniform date operators */
|
|
23082
|
-
declare const DATE_OPERATORS: OperatorType;
|
|
23083
|
-
/** @deprecated beta - uniform textbox operators */
|
|
23084
|
-
declare const TEXTBOX_OPERATORS: OperatorType;
|
|
23085
|
-
/** @deprecated beta - uniform user operators */
|
|
23086
|
-
declare const USER_OPERATORS: OperatorType;
|
|
23087
|
-
/** @deprecated beta - uniform system date operators */
|
|
23088
|
-
declare const SYSTEM_DATE_OPERATORS: OperatorType;
|
|
23089
|
-
/** @deprecated beta - uniform rich text operators */
|
|
23090
|
-
declare const RICHTEXT_OPERATORS: OperatorType;
|
|
23091
|
-
/** @deprecated beta - uniform checkbox operators */
|
|
23092
|
-
declare const CHECKBOX_OPERATORS: OperatorType;
|
|
23093
|
-
/** @deprecated beta - uniform system field operators */
|
|
23094
|
-
declare const SYSTEM_FIELD_OPERATORS: OperatorType;
|
|
23095
|
-
/** @deprecated beta - uniform publish status field operators */
|
|
23096
|
-
declare const PUBLISH_STATUS_FIELD_OPERATORS: OperatorType;
|
|
23097
|
-
|
|
23098
|
-
/** @description beta - filter button type */
|
|
23099
|
-
type FilterButtonProps = {
|
|
23100
|
-
/** text to display on the button
|
|
23101
|
-
* @default "Filters"
|
|
23102
|
-
*/
|
|
23103
|
-
text?: string;
|
|
23104
|
-
/** icon to display on the button
|
|
23105
|
-
* @default "filter-add"
|
|
23106
|
-
*/
|
|
23107
|
-
icon?: IconType;
|
|
23108
|
-
/** number of filters to display on the button and sets the styles on the button */
|
|
23109
|
-
filterCount?: number;
|
|
23110
|
-
/** sets the selected styles on the button */
|
|
23111
|
-
hasSelectedValue?: boolean;
|
|
23112
|
-
/** sets the data-testid attribute on the button */
|
|
23113
|
-
dataTestId?: string;
|
|
23114
|
-
} & HTMLAttributes<HTMLButtonElement>;
|
|
23115
|
-
/**
|
|
23116
|
-
* @deprecated beta - A filter button component used to display filter menu options
|
|
23117
|
-
* @example <FilterButton text="Filters" filterCount={3} />
|
|
23118
|
-
*/
|
|
23119
|
-
declare const FilterButton: ({ text, icon, filterCount, hasSelectedValue, dataTestId, ...props }: FilterButtonProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23120
|
-
|
|
23121
|
-
/**
|
|
23122
|
-
* @deprecated beta - Default filter controls for search and filter
|
|
23123
|
-
* @example <FilterControls />
|
|
23124
|
-
*/
|
|
23125
|
-
declare const FilterControls: ({ children, hideSearchInput, }: {
|
|
23126
|
-
/** optional param to allow you to add your own controls */
|
|
23127
|
-
children?: ReactNode;
|
|
23128
|
-
/** optional param to hide the search input */
|
|
23129
|
-
hideSearchInput?: boolean | undefined;
|
|
23130
|
-
}) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23131
|
-
|
|
23132
|
-
type FilterEditorProps = Record<FilterEditor, ComponentType<{
|
|
23133
|
-
label?: string;
|
|
23134
|
-
value?: string;
|
|
23135
|
-
options: any;
|
|
23136
|
-
onChange: (value: any) => void;
|
|
23137
|
-
}> | (() => ReactNode) | null>;
|
|
23138
|
-
type ComboboxOption = {
|
|
23139
|
-
label: string;
|
|
23140
|
-
value: string;
|
|
23141
|
-
};
|
|
23142
|
-
type SingleValueComboboxProps = Omit<FilterEditorCommonInputProps, 'value'> & {
|
|
23143
|
-
value?: string;
|
|
23144
|
-
options: ComboboxOption[];
|
|
23145
|
-
onChange: (e: string) => void;
|
|
23146
|
-
};
|
|
23147
|
-
type MultiValueComboboxProps = Omit<FilterEditorCommonInputProps, 'value'> & {
|
|
23148
|
-
value?: string[];
|
|
23149
|
-
options: ComboboxOption[];
|
|
23150
|
-
onChange: (e: string[]) => void;
|
|
23151
|
-
};
|
|
23152
|
-
type FilterEditorCommonInputProps = {
|
|
23153
|
-
ariaLabel: string;
|
|
23154
|
-
onChange: (e: string | string[]) => void;
|
|
23155
|
-
disabled?: boolean;
|
|
23156
|
-
value?: string | string[];
|
|
23157
|
-
readOnly?: boolean;
|
|
23158
|
-
valueTestId?: string;
|
|
23159
|
-
bindable?: boolean;
|
|
23160
|
-
};
|
|
23161
|
-
/**
|
|
23162
|
-
* @deprecated beta - Multie select filter component
|
|
23163
|
-
* @example <FilterMultiChoiceEditor options={options} value={options.filter((option) => values.includes(option.value)} onChange={(e) => onChange(e.map((option) => option.value))} />
|
|
23164
|
-
*/
|
|
23165
|
-
declare const FilterMultiChoiceEditor: ({ value, options, disabled, readOnly, valueTestId, ...props }: MultiValueComboboxProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23166
|
-
/**
|
|
23167
|
-
* @deprecated beta - Single select filter component
|
|
23168
|
-
* @example <FilterSingleChoiceEditor options={options} value={options.find((option) => values.includes(option.value)} onChange={(e) => onChange(e.value)} />
|
|
23169
|
-
*/
|
|
23170
|
-
declare const FilterSingleChoiceEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: SingleValueComboboxProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23171
|
-
/**
|
|
23172
|
-
* @deprecated beta - Status multi select filter component that renders a custom dropdown menu
|
|
23173
|
-
* @example <StatusMultiEditor options={options} value={value} onChange={onChange} />
|
|
23174
|
-
*/
|
|
23175
|
-
declare const StatusMultiEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: MultiValueComboboxProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23176
|
-
/**
|
|
23177
|
-
* @deprecated beta - Status single select filter component that renders a custom dropdown menu
|
|
23178
|
-
* @example <StatusSingleEditor options={options} value={value} onChange={onChange} />
|
|
23179
|
-
*/
|
|
23180
|
-
declare const StatusSingleEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: SingleValueComboboxProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23181
|
-
/**
|
|
23182
|
-
* @deprecated beta - Renders a text input field for filtering
|
|
23183
|
-
* @example <TextEditor ariaLabel="Search" value={value} onChange={onChange} />
|
|
23184
|
-
*/
|
|
23185
|
-
declare const TextEditor: ({ onChange, ariaLabel, value, readOnly, valueTestId, }: FilterEditorCommonInputProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23186
|
-
/**
|
|
23187
|
-
* @deprecated beta - Renders a number range input field for filtering
|
|
23188
|
-
* @example <NumberRangeEditor ariaLabel="Number Range" value={value} onChange={onChange} />
|
|
23189
|
-
*/
|
|
23190
|
-
declare const NumberRangeEditor: ({ onChange, disabled, ariaLabel, value, readOnly, valueTestId, }: FilterEditorCommonInputProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23191
|
-
/**
|
|
23192
|
-
* @deprecated beta - Renders a number input field for filtering
|
|
23193
|
-
* @example <NumberEditor ariaLabel="Number" value={value} onChange={onChange} />
|
|
23194
|
-
*/
|
|
23195
|
-
declare const NumberEditor: ({ ariaLabel, onChange, disabled, value, readOnly, valueTestId, }: FilterEditorCommonInputProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23196
|
-
/**
|
|
23197
|
-
* @deprecated beta - Renders a date input field for filtering
|
|
23198
|
-
* @example <DateEditor ariaLabel="Date" value={value} onChange={onChange} />
|
|
23199
|
-
*/
|
|
23200
|
-
declare const DateEditor: ({ onChange, ariaLabel, disabled, value, readOnly, valueTestId, }: FilterEditorCommonInputProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23201
|
-
/**
|
|
23202
|
-
* @deprecated beta - Renders a date range input field for filtering
|
|
23203
|
-
* @example <DateRangeEditor ariaLabel="Date Range" value={value} onChange={onChange} />
|
|
23204
|
-
*/
|
|
23205
|
-
declare const DateRangeEditor: ({ ariaLabel, onChange, disabled, value, readOnly, valueTestId, }: FilterEditorCommonInputProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23206
|
-
type FilterEditorRendererProps = Pick<FilterOption, 'readOnly' | 'disabled' | 'bindable'> & {
|
|
23207
|
-
/** The type of filter editor to render */
|
|
23208
|
-
editorType: FilterEditor;
|
|
23209
|
-
/** The options for the filter editor */
|
|
23210
|
-
options?: Array<Operator>;
|
|
23211
|
-
/** The value for the filter editor */
|
|
23212
|
-
value?: string | string[] | InputOption[] | InputOption;
|
|
23213
|
-
/** The onChange event for the filter editor */
|
|
23214
|
-
onChange: (e: string) => void;
|
|
23215
|
-
/** Sets the data-testid value */
|
|
23216
|
-
valueTestId?: string;
|
|
23217
|
-
};
|
|
23218
|
-
/**
|
|
23219
|
-
* @deprecated beta - Renders a filter editor component
|
|
23220
|
-
* @example <FilterEditorRenderer editorType="multiChoice" options={options} value={value} onChange={onChange} />
|
|
23221
|
-
*/
|
|
23222
|
-
declare const FilterEditorRenderer: ({ editorType, ...props }: FilterEditorRendererProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
|
|
23223
|
-
/** @deprecated beta - A mapper for filter editor components */
|
|
23224
|
-
declare const filterMapper: Record<FilterEditor, ComponentType<any> | null>;
|
|
23225
|
-
|
|
23226
|
-
type FilterMapper = Record<string, ComponentType<any> | null>;
|
|
23227
|
-
type SearchAndFilterProviderProps = {
|
|
23228
|
-
/** sets the filter values */
|
|
23229
|
-
filters: Filter[];
|
|
23230
|
-
/** sets the filter visibility */
|
|
23231
|
-
filterVisible?: boolean;
|
|
23232
|
-
/** function to trigger search change event */
|
|
23233
|
-
onSearchChange?: (term: string) => void;
|
|
23234
|
-
/** function to trigger filter change events */
|
|
23235
|
-
onChange: (filters: Filter[]) => void;
|
|
23236
|
-
/** Sets default value for full text search input, useful for bindable search */
|
|
23237
|
-
defaultSearchTerm?: string;
|
|
23238
|
-
/** sets the reset filter values
|
|
23239
|
-
* @default "[{ field: '', operator: '', value: '' }]"
|
|
23240
|
-
*/
|
|
23241
|
-
resetFilterValues?: Filter[];
|
|
23242
|
-
/** sets the list of filter options for each filter row */
|
|
23243
|
-
filterOptions: FilterOption[];
|
|
23244
|
-
/** the total number of results */
|
|
23245
|
-
totalResults?: number;
|
|
23246
|
-
/** the filter mapper function */
|
|
23247
|
-
filterMapper?: FilterMapper;
|
|
23248
|
-
/** sets child components giving access to useSearchAndFilter context */
|
|
23249
|
-
children: ReactNode;
|
|
23250
|
-
};
|
|
23251
|
-
type SearchAndFilterContextProps = {
|
|
23252
|
-
/** the search term value */
|
|
23253
|
-
searchTerm: string;
|
|
23254
|
-
/** sets the search term value */
|
|
23255
|
-
setSearchTerm: (term: string) => void;
|
|
23256
|
-
/** current filter visibility */
|
|
23257
|
-
filterVisibility?: boolean;
|
|
23258
|
-
/** sets the filter visibility */
|
|
23259
|
-
setFilterVisibility: (visible: boolean) => void;
|
|
23260
|
-
/** sets the initial filters */
|
|
23261
|
-
filters: Filter[];
|
|
23262
|
-
/** function to update the current filters */
|
|
23263
|
-
setFilters: (updatedFilters: Filter[]) => void;
|
|
23264
|
-
/** function that adds a blank set of filter options */
|
|
23265
|
-
handleAddFilter: () => void;
|
|
23266
|
-
/** function to reset all filter values */
|
|
23267
|
-
handleResetFilters: (filters?: Filter[]) => void;
|
|
23268
|
-
/** function that deletes a row and it's values visually and from state */
|
|
23269
|
-
handleDeleteFilter: (index: number) => void;
|
|
23270
|
-
/** sets the initial list of filter options */
|
|
23271
|
-
filterOptions: FilterOption[];
|
|
23272
|
-
/** a valid list of valid filter options */
|
|
23273
|
-
validFilterQuery: Filter[] | undefined;
|
|
23274
|
-
/** a component list to map filter options */
|
|
23275
|
-
filterMapper?: FilterMapper;
|
|
23276
|
-
/** the total number of results */
|
|
23277
|
-
totalResults?: number;
|
|
23278
|
-
};
|
|
23279
|
-
declare const SearchAndFilterContext: React$1.Context<SearchAndFilterContextProps>;
|
|
23280
|
-
/**
|
|
23281
|
-
* @deprecated beta - Search and filter provider
|
|
23282
|
-
* @example <SearchAndFilterProvider filters={filters} filterOptions={filterOptions} onSearchChange={onSearchChange} onChange={onChange}>Children</SearchAndFilterProvider>
|
|
23283
|
-
* */
|
|
23284
|
-
declare const SearchAndFilterProvider: ({ filters, filterOptions, filterVisible, defaultSearchTerm, onSearchChange, onChange, resetFilterValues, totalResults, filterMapper, children, }: SearchAndFilterProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23285
|
-
/** @deprecated beta - Search and filter hook
|
|
23286
|
-
* @example const { searchTerm, setSearchTerm, filterVisibility, setFilterVisibility, filters, setFilters, handleAddFilter, handleResetFilters, handleDeleteFilter, filterOptions, validFilterQuery } = useSearchAndFilter();
|
|
23287
|
-
*/
|
|
23288
|
-
declare const useSearchAndFilter: () => {
|
|
23289
|
-
/** the search term value */
|
|
23290
|
-
searchTerm: string;
|
|
23291
|
-
/** sets the search term value */
|
|
23292
|
-
setSearchTerm: (term: string) => void;
|
|
23293
|
-
/** current filter visibility */
|
|
23294
|
-
filterVisibility?: boolean | undefined;
|
|
23295
|
-
/** sets the filter visibility */
|
|
23296
|
-
setFilterVisibility: (visible: boolean) => void;
|
|
23297
|
-
/** sets the initial filters */
|
|
23298
|
-
filters: Filter[];
|
|
23299
|
-
/** function to update the current filters */
|
|
23300
|
-
setFilters: (updatedFilters: Filter[]) => void;
|
|
23301
|
-
/** function that adds a blank set of filter options */
|
|
23302
|
-
handleAddFilter: () => void;
|
|
23303
|
-
/** function to reset all filter values */
|
|
23304
|
-
handleResetFilters: (filters?: Filter[]) => void;
|
|
23305
|
-
/** function that deletes a row and it's values visually and from state */
|
|
23306
|
-
handleDeleteFilter: (index: number) => void;
|
|
23307
|
-
/** sets the initial list of filter options */
|
|
23308
|
-
filterOptions: FilterOption[];
|
|
23309
|
-
/** a valid list of valid filter options */
|
|
23310
|
-
validFilterQuery: Filter[] | undefined;
|
|
23311
|
-
/** a component list to map filter options */
|
|
23312
|
-
filterMapper?: FilterMapper | undefined;
|
|
23313
|
-
/** the total number of results */
|
|
23314
|
-
totalResults?: number | undefined;
|
|
23315
|
-
};
|
|
23316
|
-
|
|
23317
|
-
type SearchAndFilterProps = Omit<SearchAndFilterProviderProps, 'children'> & {
|
|
23318
|
-
/** The filter controls to be displayed
|
|
23319
|
-
* @default '<FilterControls />'
|
|
23320
|
-
*/
|
|
23321
|
-
filterControls?: React$1.ReactNode;
|
|
23322
|
-
/** sets the filter mode */
|
|
23323
|
-
filterVisible?: boolean;
|
|
23324
|
-
/** The view switch controls to be displayed */
|
|
23325
|
-
viewSwitchControls?: React$1.ReactNode;
|
|
23326
|
-
/** The number of total results */
|
|
23327
|
-
totalResults?: number;
|
|
23328
|
-
/** The results container view
|
|
23329
|
-
* @default '<SearchAndFilterResultContainer />'
|
|
23330
|
-
*/
|
|
23331
|
-
resultsContainerView?: React$1.ReactNode;
|
|
23332
|
-
/** sets the reset filter values */
|
|
23333
|
-
resetFilterValues?: Filter[];
|
|
23334
|
-
/** The filter mapper function */
|
|
23335
|
-
filterMapper?: Record<FilterEditor, React$1.ComponentType<any> | null>;
|
|
23336
|
-
/** Component to render inside filters container right below main Filters widget
|
|
23337
|
-
* that should contain additional controls like filters
|
|
23338
|
-
* which do not fit main structure or sorting */
|
|
23339
|
-
additionalFiltersContainer?: React$1.ReactNode;
|
|
23340
|
-
};
|
|
23341
|
-
/**
|
|
23342
|
-
* @deprecated beta - Search and filter component
|
|
23343
|
-
* @example <SearchAndFilter filters={filters} filterOptions={filterOptions} onChange={onChange} onSearchChange={onSearchChange} onSearchReset={onSearchReset} totalResults={totalResults} />
|
|
23344
|
-
* */
|
|
23345
|
-
declare const SearchAndFilter: ({ filters, filterOptions, filterVisible, filterControls, viewSwitchControls, resultsContainerView, filterMapper, additionalFiltersContainer, onChange, defaultSearchTerm, onSearchChange, totalResults, resetFilterValues, }: SearchAndFilterProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23346
|
-
|
|
23347
|
-
type FilterRowProps = {
|
|
23348
|
-
/** the index of the filter row */
|
|
23349
|
-
index: number;
|
|
23350
|
-
/** the list of filter options for each filter row */
|
|
23351
|
-
paramOptions: FilterOption[];
|
|
23352
|
-
/** function to trigger filter change events */
|
|
23353
|
-
onParamChange: (e: string) => void;
|
|
23354
|
-
/** the list of operator options for each filter row */
|
|
23355
|
-
operatorOptions: Operator[];
|
|
23356
|
-
/** function to trigger operator change events */
|
|
23357
|
-
onOperatorChange: (e: string) => void;
|
|
23358
|
-
/** function to trigger value change events */
|
|
23359
|
-
onValueChange: (e: string) => void;
|
|
23360
|
-
/** the list of value options for each filter row */
|
|
23361
|
-
valueOptions: InputOption[];
|
|
23362
|
-
};
|
|
23363
|
-
/** @deprecated beta - A filter item component used to display filter options */
|
|
23364
|
-
declare const FilterItem: ({ index, paramOptions, operatorOptions, valueOptions, onParamChange, onOperatorChange, onValueChange, }: FilterRowProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23365
|
-
type FilterItemsProps = {
|
|
23366
|
-
/** The text for the add button */
|
|
23367
|
-
addButtonText?: string;
|
|
23368
|
-
additionalFiltersContainer: SearchAndFilterProps['additionalFiltersContainer'];
|
|
23369
|
-
};
|
|
23370
|
-
/** @deprecated beta - A filter items component used to display filter options */
|
|
23371
|
-
declare const FilterItems: ({ addButtonText, additionalFiltersContainer, }: FilterItemsProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23372
|
-
|
|
23373
|
-
type SearchAndFilterOptionsContainerProps = {
|
|
23374
|
-
/** The button row to be displayed at the bottom of the container */
|
|
23375
|
-
buttonRow?: React__default.ReactNode;
|
|
23376
|
-
/** The children of the container */
|
|
23377
|
-
children: React__default.ReactNode;
|
|
23378
|
-
additionalFiltersContainer?: SearchAndFilterProps['additionalFiltersContainer'];
|
|
23379
|
-
};
|
|
23380
|
-
/**
|
|
23381
|
-
* @deprecated beta - A container component for search and filter options
|
|
23382
|
-
* @example <SearchAndFilterOptionsContainer buttonRow={<button>Button</button>}>Children</SearchAndFilterOptionsContainer>
|
|
23383
|
-
* */
|
|
23384
|
-
declare const SearchAndFilterOptionsContainer: ({ buttonRow, additionalFiltersContainer, children, }: SearchAndFilterOptionsContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23385
|
-
type FiltersProps = {
|
|
23386
|
-
/** The id of the filter menu */
|
|
23387
|
-
id: string;
|
|
23388
|
-
/** The text for the filter title */
|
|
23389
|
-
filterTitle?: string;
|
|
23390
|
-
/** The controls to be displayed at the bottom of the filter menu */
|
|
23391
|
-
menuControls?: React__default.ReactNode;
|
|
23392
|
-
/** The children of the filter menu */
|
|
23393
|
-
children: React__default.ReactNode;
|
|
23394
|
-
/** Sets the data-test-id attribute for the filter menu */
|
|
23395
|
-
dataTestId?: string;
|
|
23396
|
-
/** The text for the reset button
|
|
23397
|
-
* @default 'reset'
|
|
23398
|
-
*/
|
|
23399
|
-
resetButtonText?: string;
|
|
23400
|
-
additionalFiltersContainer?: SearchAndFilterProps['additionalFiltersContainer'];
|
|
23401
|
-
};
|
|
23402
|
-
/**
|
|
23403
|
-
* @deprecated beta - A filter menu component used to display filter options
|
|
23404
|
-
* @example <FilterMenu id="search-and-filter-options">Children</FilterMenu>
|
|
23405
|
-
* */
|
|
23406
|
-
declare const FilterMenu: ({ id, filterTitle, menuControls, additionalFiltersContainer, children, dataTestId, resetButtonText, }: FiltersProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23407
|
-
|
|
23408
|
-
type SearchAndFilterResultContainerProps = {
|
|
23409
|
-
/** The label for the clear button
|
|
23410
|
-
* @default 'Clear'
|
|
23411
|
-
*/
|
|
23412
|
-
clearButtonLabel?: string;
|
|
23413
|
-
/** The text for the button */
|
|
23414
|
-
buttonText?: string;
|
|
23415
|
-
/** The title for the callout */
|
|
23416
|
-
calloutTitle?: string;
|
|
23417
|
-
/** The text for the callout */
|
|
23418
|
-
calloutText?: string;
|
|
23419
|
-
/** The function to handle the clear button */
|
|
23420
|
-
onHandleClear?: () => void;
|
|
23421
|
-
/** Sets whether to show or hide both clear search buttons */
|
|
23422
|
-
hideClearButton?: boolean;
|
|
23423
|
-
};
|
|
23424
|
-
/** @deprecated beta - Search and filter results container */
|
|
23425
|
-
declare const SearchAndFilterResultContainer: ({ buttonText, clearButtonLabel, calloutTitle, calloutText, onHandleClear, hideClearButton, }: SearchAndFilterResultContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
|
|
23426
|
-
|
|
23427
|
-
declare const SearchOnlyContext: React$1.Context<Pick<SearchAndFilterContextProps, "searchTerm" | "setSearchTerm">>;
|
|
23428
|
-
type SearchOnlyProviderProps = Pick<SearchAndFilterProviderProps, 'onSearchChange'> & {
|
|
23429
|
-
/** sets the max width of input wrapper
|
|
23430
|
-
* @default '712px'
|
|
23431
|
-
*/
|
|
23432
|
-
maxWidth?: string;
|
|
23433
|
-
};
|
|
23434
|
-
declare const SearchOnlyFilter: ({ onSearchChange, maxWidth }: SearchOnlyProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23435
|
-
|
|
23436
23039
|
type SegmentedControlOption<TValue extends string = string> = {
|
|
23437
23040
|
value: TValue;
|
|
23438
23041
|
label?: string;
|
|
@@ -23920,4 +23523,4 @@ type StatusBulletProps = React$1.HTMLAttributes<HTMLSpanElement> & {
|
|
|
23920
23523
|
};
|
|
23921
23524
|
declare const StatusBullet: ({ status, hideText, size, message, ...props }: StatusBulletProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
23922
23525
|
|
|
23923
|
-
export { type ActionButtonsProps, AddButton, type AddButtonProps, AddListButton, type AddListButtonProps, type AddListButtonThemeProps, AnimationFile, type AnimationFileProps, type ArrowPositionProps, Avatar, AvatarGroup, type AvatarGroupProps, type AvatarProps, Badge, type BadgeProps, type BadgeSizeProps, type BadgeThemeProps, type BadgeThemeStyleProps, Banner, type BannerProps, type BannerType, type BoxHeightProps, type BreakpointSize, type BreakpointsMap, Button, type ButtonProps, type ButtonSizeProps$1 as ButtonSizeProps, type ButtonThemeProps$1 as ButtonThemeProps, ButtonWithMenu, type ButtonWithMenuProps,
|
|
23526
|
+
export { type ActionButtonsProps, AddButton, type AddButtonProps, AddListButton, type AddListButtonProps, type AddListButtonThemeProps, AnimationFile, type AnimationFileProps, type ArrowPositionProps, Avatar, AvatarGroup, type AvatarGroupProps, type AvatarProps, Badge, type BadgeProps, type BadgeSizeProps, type BadgeThemeProps, type BadgeThemeStyleProps, Banner, type BannerProps, type BannerType, BetaDecorator, type BoxHeightProps, type BreakpointSize, type BreakpointsMap, Button, type ButtonProps, type ButtonSizeProps$1 as ButtonSizeProps, type ButtonThemeProps$1 as ButtonThemeProps, ButtonWithMenu, type ButtonWithMenuProps, Calendar, type CalendarProps, Callout, type CalloutProps, type CalloutType, Caption, type CaptionProps, Card, CardContainer, type CardContainerBgColorProps, type CardContainerProps, type CardProps, CardTitle, type CardTitleProps, CheckboxWithInfo, type CheckboxWithInforProps, type ChildFunction, Chip, type ChipProps, type ChipTheme, type ComboBoxGroupBase, ConnectToDataElementButton, type ConnectToDataElementButtonProps, Container, type ContainerProps, Counter, type CounterProps, CreateTeamIntegrationTile, type CreateTeamIntegrationTileProps, CurrentDrawerContext, DashedBox, type DashedBoxProps, DateTimePicker, type DateTimePickerProps, type DateTimePickerValue, DateTimePickerVariant, DebouncedInputKeywordSearch, type DebouncedInputKeywordSearchProps, DescriptionList, type DescriptionListProps, Details, type DetailsProps, DismissibleChipAction, Drawer, DrawerContent, type DrawerContentProps, type DrawerContextValue, type DrawerItem, type DrawerProps, DrawerProvider, DrawerRenderer, type DrawerRendererItemProps, type DrawerRendererProps, type DrawersRegistryRecord, EditTeamIntegrationTile, type EditTeamIntegrationTileProps, ErrorMessage, type ErrorMessageProps, FieldMessage, type FieldMessageProps, Fieldset, type FieldsetProps, Heading, type HeadingProps, HexModalBackground, HorizontalRhythm, Icon, IconButton, type IconButtonProps, type IconColor, type IconName, type IconProps, type IconType, IconsProvider, Image, ImageBroken, type ImageProps, InfoMessage, type InfoMessageProps, InlineAlert, type InlineAlertProps, Input, InputComboBox, type InputComboBoxOption, type InputComboBoxProps, InputInlineSelect, type InputInlineSelectOption, type InputInlineSelectProps, InputKeywordSearch, type InputKeywordSearchProps, type InputProps, InputSelect, type InputSelectProps, InputTime, type InputTimeProps, InputToggle, type InputToggleProps, IntegrationComingSoon, type IntegrationComingSoonProps, IntegrationHeaderSection, type IntegrationHeaderSectionProps, IntegrationLoadingTile, type IntegrationLoadingTileProps, IntegrationModalHeader, type IntegrationModalHeaderProps, IntegrationModalIcon, type IntegrationModalIconProps, IntegrationTile, type IntegrationTileProps, type IsoDateString, type IsoDateTimeString, type IsoTimeString, JsonEditor, type JsonEditorProps, Label, LabelLeadingIcon, type LabelProps, Legend, type LegendProps, type LevelProps, LimitsBar, type LimitsBarProps, Link, type LinkColorProps, LinkList, type LinkListProps, type LinkManagerWithRefType, LinkNode, type LinkProps, LinkWithRef, LoadingCardSkeleton, LoadingIcon, type LoadingIconProps, LoadingIndicator, LoadingOverlay, type LoadingOverlayProps, MediaCard, type MediaCardProps, Menu, MenuGroup, type MenuGroupProps, MenuItem, MenuItemInner, type MenuItemProps, MenuItemSeparator, type MenuItemTextThemeProps, type MenuProps, Modal, ModalDialog, type ModalDialogProps, type ModalProps, MultilineChip, type MultilineChipProps, PageHeaderSection, type PageHeaderSectionProps, Pagination, Paragraph, type ParagraphProps, type ParameterDataConnectButtonProps, ParameterDataResource, ParameterDrawerHeader, type ParameterDrawerHeaderProps, ParameterGroup, type ParameterGroupProps, ParameterImage, ParameterImageInner, ParameterImagePreview, type ParameterImageProps, ParameterInput, ParameterInputInner, type ParameterInputProps, ParameterLabel, type ParameterLabelProps, ParameterLink, ParameterLinkInner, type ParameterLinkProps, ParameterMenuButton, type ParameterMenuButtonProps, ParameterNameAndPublicIdInput, type ParameterNameAndPublicIdInputProps, ParameterOverrideMarker, ParameterRichText, ParameterRichTextInner, type ParameterRichTextInnerProps, type ParameterRichTextProps, ParameterSelect, ParameterSelectInner, type ParameterSelectProps, ParameterShell, ParameterShellContext, ParameterShellPlaceholder, type ParameterShellProps, ParameterTextarea, ParameterTextareaInner, type ParameterTextareaProps, ParameterToggle, ParameterToggleInner, type ParameterToggleProps, Popover, type PopoverProps, ProgressBar, type ProgressBarProps, ProgressList, ProgressListItem, type ProgressListItemProps, type ProgressListProps, type RegisterDrawerProps, ResolveIcon, type ResolveIconProps, type RhythmProps, type RichTextParamValue, RichTextToolbarIcon, type ScrollableItemProps, ScrollableList, type ScrollableListContainerProps, ScrollableListInputItem, ScrollableListItem, type ScrollableListItemProps, type ScrollableListProps, SegmentedControl, type SegmentedControlOption, type SegmentedControlProps, type SerializedLinkNode, ShortcutContext, ShortcutRevealer, Skeleton, type SkeletonProps, StatusBullet, type StatusBulletProps, type StatusTypeProps, SuccessMessage, type SuccessMessageProps, Switch, type SwitchProps, TAKEOVER_STACK_ID, TabButton, TabButtonGroup, type TabButtonProps, TabContent, type TabContentProps, Table, TableBody, type TableBodyProps, TableCellData, type TableCellDataProps, TableCellHead, type TableCellHeadProps, TableFoot, type TableFootProps, TableHead, type TableHeadProps, type TableProps, TableRow, type TableRowProps, Tabs, type TabsProps, TakeoverDrawerRenderer, type TextAlignProps, Textarea, type TextareaProps, Theme, type ThemeProps, Tile, TileContainer, type TileContainerProps, type TileProps, TileText, type TileTitleProps, ToastContainer, type ToastContainerProps, Tooltip, type TooltipProps, TwoColumnLayout, type TwoColumnLayoutProps, UniformBadge, UniformLogo, UniformLogoLarge, type UniformLogoProps, type UseShortcutOptions, VerticalRhythm, WarningMessage, type WarningMessageProps, accessibleHidden, addPathSegmentToPathname, borderTopIcon, breakpoints, button, buttonAccentAltDark, buttonAccentAltDarkOutline, buttonDestructive, buttonGhost, buttonGhostDestructive, buttonGhostUnimportant, buttonPrimary, buttonPrimaryInvert, buttonRippleEffect, buttonSecondary, buttonSecondaryInvert, buttonTertiary, buttonTertiaryOutline, buttonUnimportant, canvasAlertIcon, cardIcon, cq, customIcons, extractParameterProps, fadeIn, fadeInBottom, fadeInLtr, fadeInRtl, fadeInTop, fadeOutBottom, fullWidthScreenIcon, getDrawerAttributes, getParentPath, getPathSegment, growSubtle, imageTextIcon, infoFilledIcon, input, inputError, inputSelect, isMacLike, isSecureURL, isValidUrl, jsonIcon, labelText, loader as loaderAnimationData, macifyShortcut, mq, numberInput, queryStringIcon, rectangleRoundedIcon, replaceUnderscoreInString, richTextToolbarButton, richTextToolbarButtonActive, ripple, scrollbarStyles, settings, settingsIcon, skeletonLoading, slideInTtb, spin, spinner as spinnerAnimationData, structurePanelIcon, supports, textInput, useBreakpoint, useCloseCurrentDrawer, useCurrentDrawer, useCurrentTab, useDateTimePickerContext, useDrawer, useIconContext, useOutsideClick, useParameterShell, useShortcut, warningIcon, yesNoIcon };
|