@uniformdev/mesh-sdk-react 20.75.1-alpha.16 → 20.76.1-alpha.3

package/dist/index.d.ts

@@ -59,16 +59,27 @@ declare function DataResourceDynamicInputProvider(props: DataResourceDynamicInpu
 
 /**
  * Provides convenient access to the current Uniform Mesh location via React hook.
- * Intended to be used within <MeshApp />.
+ * Intended to be used within `MeshApp`.
  *
  * There are three primary ways to invoke this hook:
  * 1. Without any arguments, this hook will return the current location regardless of its type. The result will be a union of all possible locations you can discriminate between i.e. with an if statement on the `type`
- *    const location = useMeshLocation();
- *    if (location.type === 'paramType') { // location is now known to be a paramType }
+ * @example
+ * ```tsx
+ * const location = useMeshLocation();
+ * if (location.type === 'paramType') {
+ *   // location is now known to be a paramType
+ * }
+ * ```
  * 2. With a string argument, this hook will assert that the current location is the expected one and return the correct typings for that location.
- *    const location = useMeshLocation('settings');
+ * @example
+ * ```tsx
+ * const location = useMeshLocation('settings');
+ * ```
  * 3. With an explicit generic to set the expected param type data or param type settings data. This is useful because (2) will return unknown as the value type for param types.
- *    const location = useMeshLocation<'paramType', MyParamTypeValueType>();
+ * @example
+ * ```tsx
+ * const location = useMeshLocation<'paramType', MyParamTypeValueType>();
+ * ```
  *
  * You can also combine (2) and (3) to get both explicit value typing and assertion of the location.
  */
@@ -514,7 +525,7 @@ type InputVariablesProps<TEditorContext = unknown> = {
      * disable it with this prop.
      */
     disableDismissEditorOnChange?: boolean;
-    /** Enables mutliple lines in the input (\n in the value) */
+    /** Enables mutliple lines in the input (newline characters in the value) */
     multiLine?: boolean;
     /** Disables the inline variable selection menu when rendering a variables input */
     disableInlineMenu?: boolean | 'by-label' | 'by-input';
@@ -629,7 +640,7 @@ type ParameterVariablesProps<TEditorContext = unknown> = {
     /** Sets the test ID of the input */
     'data-testid'?: string;
     /**
-     * Enables mutliple lines in the input (\n in the value).
+     * Enables mutliple lines in the input (newline characters in the value).
      * If a number is passed, the height of the editor is set to that number of lines and overflow scrolls.
      * If a boolean true is passed, the editor auto-sizes to the content.
      */
@@ -813,12 +824,12 @@ declare function variableDefaultTextValue(defaultValue: unknown): string;
 
 /**
  * Expected prefix for variable expressions
- * @deprecated
+ * @deprecated Use the variables binding API instead of string delimiters.
  */
 declare const variablePrefix = "${";
 /**
  * Expected suffix for variable expressions
- * @deprecated
+ * @deprecated Use the variables binding API instead of string delimiters.
  */
 declare const variableSuffix = "}";
 
@@ -1029,8 +1040,11 @@ type DataRefreshButtonProps = HTMLAttributes<HTMLButtonElement> & {
     onRefreshData: () => void;
 };
 /**
- * @description The data refresh button is a UI component to indicate to users a request for data is taking place
- * @example <DataRefreshButton buttonText="my button" isLoading />
+ * The data refresh button is a UI component to indicate to users a request for data is taking place
+ * @example
+ * ```tsx
+ * <DataRefreshButton buttonText="my button" isLoading />
+ * ```
  * @deprecated this component is not recommended for use in new projects
  */
 declare const DataRefreshButton: ({ buttonText, isLoading, onRefreshData, ...props }: DataRefreshButtonProps) => _emotion_react_jsx_runtime.JSX.Element;
@@ -1058,8 +1072,11 @@ type ObjectSearchContainerProps = {
     children?: ReactNode;
 };
 /**
- * @description Object search container is an opinionated layout for search parameters and retrieved results
- * @example  <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} />
+ * Object search container is an opinionated layout for search parameters and retrieved results
+ * @example
+ * ```tsx
+ * <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} />
+ * ```
  * @deprecated this component is not recommended for use in new projects
  */
 declare const ObjectSearchContainer: ({ label, enableDynamicInputToResultId, searchFilters, resultList, children, }: ObjectSearchContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
@@ -1068,11 +1085,11 @@ type ObjectSearchFilterProps = {
     /** shows or hides the required content type select option */
     requireContentType?: boolean;
     /** sets the text for the required content type select option
-     * @default 'All content types'
+     * @defaultValue 'All content types'
      */
     typeSelectorAllTypesOptionText?: string;
     /** sets the select input value label text
-     * @default 'Content Type Select'
+     * @defaultValue 'Content Type Select'
      */
     selectLabel?: string;
     /** sets the select input options, if empty - only keyword search field will be rendered */
@@ -1081,18 +1098,21 @@ type ObjectSearchFilterProps = {
         value?: string;
     }>;
     /** sets the search input name value
-     * @default 'searchText'
+     * @defaultValue 'searchText'
      */
     searchInputName?: string;
     /** sets the search input placeholder text
-     * @default 'Enter keyword to narrow your results'
+     * @defaultValue 'Enter keyword to narrow your results'
      */
     searchInputPlaceholderText?: string;
 };
 /**
- * @description Object search filter is an opinionated filter that has pre-defined query and setQuery functions
+ * Object search filter is an opinionated filter that has pre-defined query and setQuery functions
  * that can be extended with custom functions
- * @example  <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} />
+ * @example
+ * ```tsx
+ * <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} />
+ * ```
  * @deprecated this component is not recommended for use in new projects
  */
 declare const ObjectSearchFilter: ({ requireContentType, typeSelectorAllTypesOptionText, searchInputName, searchInputPlaceholderText, selectLabel, selectOptions, }: ObjectSearchFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
@@ -1102,8 +1122,11 @@ type ObjectSearchFilterContainerProps = {
     children?: React.ReactNode;
 };
 /**
- * @description an opinionated layout for search filters
- * @example <ObjectSearchFilterContainer label="my label"><input type="text" aria-label="my input" /></ObjectSearchFilterContainer>
+ * an opinionated layout for search filters
+ * @example
+ * ```tsx
+ * <ObjectSearchFilterContainer label="my label"><input type="text" aria-label="my input" /></ObjectSearchFilterContainer>
+ * ```
  * @deprecated this component is not recommended for use in new projects
  */
 declare const ObjectSearchFilterContainer: ({ children }: ObjectSearchFilterContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
@@ -1113,20 +1136,23 @@ type ObjectSearchResultItemProps = SelectedItemProps & {
     /** sets additional remove functionality onto of default removal */
     onRemove?: () => void;
     /** sets whether to show or hide the remove button
-     * @default false
+     * @defaultValue false
      */
     hideRemoveButton?: boolean;
     /** sets user defined child nodes that are uncontrolled by Uniform */
     children?: ReactNode;
     /** disable or enable drag and drop functionality
-     * @default false
+     * @defaultValue false
      */
     disableDnD?: boolean;
     onClick?: () => void;
 };
 /**
- * @description An opinionated result item, best used for selected results
- * @example <ObjectSearchResultItem id="my-result" title="title" />
+ * An opinionated result item, best used for selected results
+ * @example
+ * ```tsx
+ * <ObjectSearchResultItem id="my-result" title="title" />
+ * ```
  * @deprecated this component is not recommended for use in new projects
  */
 declare const ObjectSearchResultItem: ({ id, title, contentType, popoverData, publishStatus, editLinkIcon, editLink, imageUrl, onRemove, createdAt, publishedAt, hideRemoveButton, disableDnD, children, onClick, }: ObjectSearchResultItemProps) => _emotion_react_jsx_runtime.JSX.Element;
@@ -1163,7 +1189,7 @@ type SelectedItemProps<TExtraProps = unknown> = {
         /** sets the text value of the publish badge */
         text: string;
         /** sets the theme value of the publish badge
-         * @default 'unimportant'
+         * @defaultValue 'unimportant'
          */
         theme?: BadgeThemeProps;
     };
@@ -1227,21 +1253,27 @@ type ObjectSearchListItemProps = SelectedItemProps & {
     /** allows authors to add any child component that is not controlled by Uniform */
     children?: React$1.ReactNode;
     /** sets whether multiple entries can be added to the results list context
-     * @default inherit from context or false
+     * @defaultValue inherit from context or false
      */
     isMulti?: boolean;
     /** sets disabled state to the interactive element */
     disabled?: boolean;
 } & React$1.HTMLAttributes<HTMLDivElement>;
 /**
- * @description entry search list item is an opinionated UI component best used for initial retrieved results
- * @example <ObjectSearchListItem  id="my-result-item" title="title" popoverData={<p>some data info</p>}><div>example of uncontrolled content</div></ObjectSearchListItem>
+ * entry search list item is an opinionated UI component best used for initial retrieved results
+ * @example
+ * ```tsx
+ * <ObjectSearchListItem  id="my-result-item" title="title" popoverData={<p>some data info</p>}><div>example of uncontrolled content</div></ObjectSearchListItem>
+ * ```
  * @deprecated this component is not recommended for use in new projects
  */
 declare const ObjectSearchListItem: ({ id, title, contentType, imageUrl, popoverData, onSelect, isMulti, disabled, children, ...props }: ObjectSearchListItemProps & React$1.HTMLAttributes<HTMLDivElement>) => _emotion_react_jsx_runtime.JSX.Element;
 /**
  * An opinionated loading skeleton component best used with ObjectSearchListItem
- * @example <ObjectSearchListItemLoadingSkeleton />
+ * @example
+ * ```tsx
+ * <ObjectSearchListItemLoadingSkeleton />
+ * ```
  */
 declare const ObjectSearchListItemLoadingSkeleton: () => _emotion_react_jsx_runtime.JSX.Element;
 
@@ -1254,22 +1286,28 @@ type ObjectSearchResultItemButtonProps<THtml extends HTMLAttributes<HTMLElement>
     }>;
 } & THtml;
 /**
- * @description An opinionated button component best used within the ObjectSearchResultItem component
- * @example <ObjectSearchResultItemButton text="button text" icon="/my-image.png" onClick={() => myFunction()} />
+ * An opinionated button component best used within the ObjectSearchResultItem component
+ * @example
+ * ```tsx
+ * <ObjectSearchResultItemButton text="button text" icon="/my-image.png" onClick={() => myFunction()} />
+ * ```
  * @deprecated this component is not recommended for use in new projects
  */
 declare const ObjectSearchResultItemButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<HTMLAttributes<HTMLButtonElement>>) => _emotion_react_jsx_runtime.JSX.Element;
 /**
- * @description An opinionated link component styled the same of the ObjectSearchResultItemButton component,
+ * An opinionated link component styled the same of the ObjectSearchResultItemButton component,
  * that automatically sets the target and rel attributes. Best used within the ObjectSearchResultItem component
- * @example <LinkButton text="link text" icon="/my-image.png" />
+ * @example
+ * ```tsx
+ * <LinkButton text="link text" icon="/my-image.png" />
+ * ```
  * @deprecated this component is not recommended for use in new projects
  */
 declare const LinkButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<Omit<AnchorHTMLAttributes<HTMLAnchorElement>, "target" | "rel">>) => _emotion_react_jsx_runtime.JSX.Element;
 
 type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = SelectedItemProps> = {
     /** sets the result label value
-     * @default 'Selected'
+     * @defaultValue 'Selected'
      */
     resultLabelText?: string;
     /** sets and override react node replacing the whole HTML block for the result label and counter */
@@ -1277,11 +1315,11 @@ type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = Se
     /** sets the on remove button click action */
     onRemoveAllSelected?: () => void;
     /** sets the remove button text
-     * @default 'Remove all'
+     * @defaultValue 'Remove all'
      */
     removeButtonText?: string;
     /** sets whether to show or hide the remove button
-     * @default false
+     * @defaultValue false
      */
     hideRemoveButton?: boolean;
     /** allows additional buttons to be added to the result title group */
@@ -1289,7 +1327,7 @@ type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = Se
     /** allows placing child components within the result list area */
     renderResultComponent?: (value: TRenderComponent) => React__default.ReactNode;
     /** disable or enable drag and drop functionality
-     * @default false
+     * @defaultValue false
      */
     disableDnD?: boolean;
     /** sets the draggable id value */
@@ -1304,10 +1342,13 @@ type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = Se
     getContainerForDnDReparenting?: () => HTMLElement;
 };
 /**
- * @description An opinionated result list UI component that has built in drag and drop functionality and removal of all selected items from context.
- * The result item component defaults to <ObjectSearchResultItem {...props} />, however this can be overridden with any other UI component and still
+ * An opinionated result list UI component that has built in drag and drop functionality and removal of all selected items from context.
+ * The result item component defaults to `ObjectSearchResultItem`, however this can be overridden with any other UI component and still
  * maintain drag and drop functionality
- * @example <ObjectSearchResultList id="my-id" title="title" renderResultComponent={(values) => <CustomComponent {...values} />} />
+ * @example
+ * ```tsx
+ * <ObjectSearchResultList id="my-id" title="title" renderResultComponent={(values) => <CustomComponent {...values} />} />
+ * ```
  * @deprecated this component is not recommended for use in new projects
  */
 declare function ObjectSearchResultList<TRenderComponent extends SelectedItemProps = SelectedItemProps>({ resultLabelText, removeButtonText, onRemoveAllSelected, hideRemoveButton, resultLabelOverride, additionalButtons, renderResultComponent, multiSelectId, disableDnD, getContainerForDnDReparenting, whenNothingSelected, }: ObjectSearchResultListProps<TRenderComponent>): _emotion_react_jsx_runtime.JSX.Element;
@@ -1321,23 +1362,22 @@ type QueryFilterSearchProps = {
     sortOrder: string;
 };
 type QueryFilterSelectionOptionProps = Array<{
-    /** contains id or machine values. will be used as value attribute in <option> */
+    /** contains id or machine values; used as the value attribute on HTML option elements */
     value?: string;
-    /** Contains human-readable display name for select options.
-     *  Used as value in case value is not present <option> */
+    /** Contains human-readable display name for select options. Used as the option label when value is not present. */
     label: string;
 }>;
 type QueryFilterProps<TSelectOptions extends QueryFilterSelectionOptionProps = QueryFilterSelectionOptionProps> = {
     /** sets the query filter title
-     * @default 'Configure Query'
+     * @defaultValue 'Configure Query'
      */
     queryFilterTitle?: string;
     /** sets the content type all selected options label
-     * @default 'All content types'
+     * @defaultValue 'All content types'
      */
     typeSelectorAllTypesOptionText?: string;
     /** sets the content type label value
-     * @default 'Filter by content type'
+     * @defaultValue 'Filter by content type'
      */
     contentTypeLabel?: string;
     /** sets the content type select options */
@@ -1345,39 +1385,42 @@ type QueryFilterProps<TSelectOptions extends QueryFilterSelectionOptionProps = Q
     /** sets whether the content type filter is required */
     requireContentType?: boolean;
     /** sets the count label value
-     * @default 'Count'
+     * @defaultValue 'Count'
      */
     countLabel?: string;
     /** sets the sort label text
-     * @default 'Sort'
+     * @defaultValue 'Sort'
      */
     sortLabel?: string;
     /** sets the sort select options value */
     sortOptions: TSelectOptions;
     /** sets the sort order lable value
-     * @default 'Sort Order'
+     * @defaultValue 'Sort Order'
      */
     sortOrderLabel?: string;
     /** sets the sort order select options value */
     sortOrderOptions: TSelectOptions;
     /** sets the search input name value
-     * @default 'searchText'
+     * @defaultValue 'searchText'
      */
     searchInputName?: string;
     /** sets the search input placeholder text
-     * @default 'Enter keyword to narrow your results'
+     * @defaultValue 'Enter keyword to narrow your results'
      */
     searchInputPlaceholderText?: string;
     /** sets the label for the search input
-     * @default 'Query'
+     * @defaultValue 'Query'
      */
     searchInputLabel?: string;
     /** allows for additional child components, for example more input components */
     children?: ReactNode;
 };
 /**
- * @description An opinionated multi query filter UI component, best used for querying product data or more complex scenarios
- * @example <QueryFilter contentTypeOptions={[{ id: 'id', name: 'name' }]} sortOptions={[{ id: 'id', name: 'name' }]} sortOrderOptions={[{ id: 'id', name: 'name' }]} />
+ * An opinionated multi query filter UI component, best used for querying product data or more complex scenarios
+ * @example
+ * ```tsx
+ * <QueryFilter contentTypeOptions={[{ id: 'id', name: 'name' }]} sortOptions={[{ id: 'id', name: 'name' }]} sortOrderOptions={[{ id: 'id', name: 'name' }]} />
+ * ```
  * @deprecated this component is not recommended for use in new projects
  */
 declare const QueryFilter: ({ requireContentType, queryFilterTitle, contentTypeLabel, typeSelectorAllTypesOptionText, contentTypeOptions, searchInputName, searchInputPlaceholderText, searchInputLabel, countLabel, sortLabel, sortOptions, sortOrderLabel, sortOrderOptions, children, }: QueryFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
@@ -1481,17 +1524,21 @@ declare function useRequest(): RequestContext;
 
 type RequestTypeContainerProps = React$1.HTMLAttributes<HTMLDivElement> & {
     /**sets the background color of the container
-     * @default 'transparent'
+     * @defaultValue 'transparent'
      */
     bgColor?: 'transparent' | 'var(--gray-100)';
     children: React$1.ReactNode;
 };
 /**
- * @description a container to layout content in a 2 column grid format = 12ch 1fr
- * @example <RequestTypeContainer bgColor="var(--gray-100)">
- * <label>Name <input type="text" /></label>
- * <label>Name <input type="text" /></label>
- * </div> */
+ * a container to layout content in a 2 column grid format = 12ch 1fr
+ * @example
+ * ```tsx
+ * <RequestTypeContainer bgColor="var(--gray-100)">
+ *   <label>Name <input type="text" /></label>
+ *   <label>Name <input type="text" /></label>
+ * </RequestTypeContainer>
+ * ```
+ */
 declare const RequestTypeContainer: ({ bgColor, children, ...props }: RequestTypeContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
 
 /**
@@ -1708,37 +1755,55 @@ declare const MULTI_SELECT_OPERATORS: OperatorType;
 
 /**
  * Renders a date input field for filtering
- * @example <DateEditor ariaLabel="Date" value={value} onChange={onChange} />
+ * @example
+ * ```tsx
+ * <DateEditor ariaLabel="Date" value={value} onChange={onChange} />
+ * ```
  */
 declare const DateEditor: ({ onChange, ariaLabel, disabled, value, readOnly, valueTestId, }: FilterEditorRendererProps<string>) => _emotion_react_jsx_runtime.JSX.Element;
 
 /**
  * Renders a date range input field for filtering
- * @example <DateRangeEditor ariaLabel="Date Range" value={value} onChange={onChange} />
+ * @example
+ * ```tsx
+ * <DateRangeEditor ariaLabel="Date Range" value={value} onChange={onChange} />
+ * ```
  */
 declare const DateRangeEditor: ({ ariaLabel, onChange, disabled, value, readOnly, valueTestId, }: FilterEditorRendererProps<string[]>) => _emotion_react_jsx_runtime.JSX.Element;
 
 /**
  * Multi select filter component
- * @example <FilterMultiChoiceEditor options={options} value={options.filter((option) => values.includes(option.value)} onChange={(e) => onChange(e.map((option) => option.value))} />
+ * @example
+ * ```tsx
+ * <FilterMultiChoiceEditor options={options} value={options.filter((option) => values.includes(option.value)} onChange={(e) => onChange(e.map((option) => option.value))} />
+ * ```
  */
 declare const FilterMultiChoiceEditor: ({ value, options, disabled, readOnly, valueTestId, ...props }: FilterEditorRendererProps<string[]>) => _emotion_react_jsx_runtime.JSX.Element;
 
 /**
  * Single select filter component
- * @example <FilterSingleChoiceEditor options={options} value={options.find((option) => values.includes(option.value)} onChange={(e) => onChange(e.value)} />
+ * @example
+ * ```tsx
+ * <FilterSingleChoiceEditor options={options} value={options.find((option) => values.includes(option.value)} onChange={(e) => onChange(e.value)} />
+ * ```
  */
 declare const FilterSingleChoiceEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: FilterEditorRendererProps<string>) => _emotion_react_jsx_runtime.JSX.Element;
 
 /**
  * Renders a number input field for filtering
- * @example <NumberEditor ariaLabel="Number" value={value} onChange={onChange} />
+ * @example
+ * ```tsx
+ * <NumberEditor ariaLabel="Number" value={value} onChange={onChange} />
+ * ```
  */
 declare const NumberEditor: ({ ariaLabel, onChange, disabled, value, readOnly, valueTestId, }: FilterEditorRendererProps<string>) => _emotion_react_jsx_runtime.JSX.Element;
 
 /**
  * Renders a number range input field for filtering
- * @example <NumberRangeEditor ariaLabel="Number Range" value={value} onChange={onChange} />
+ * @example
+ * ```tsx
+ * <NumberRangeEditor ariaLabel="Number Range" value={value} onChange={onChange} />
+ * ```
  */
 declare const NumberRangeEditor: ({ onChange, disabled, ariaLabel, value, readOnly, valueTestId, }: FilterEditorRendererProps<string[]>) => _emotion_react_jsx_runtime.JSX.Element;
 
@@ -1750,19 +1815,28 @@ declare const readOnlyAttributes: {
 
 /**
  * Status multi select filter component that renders a custom dropdown menu
- * @example <StatusMultiEditor options={options} value={value} onChange={onChange} />
+ * @example
+ * ```tsx
+ * <StatusMultiEditor options={options} value={value} onChange={onChange} />
+ * ```
  */
 declare const StatusMultiEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: FilterEditorRendererProps<string[]>) => _emotion_react_jsx_runtime.JSX.Element;
 
 /**
  * Status single select filter component that renders a custom dropdown menu
- * @example <StatusSingleEditor options={options} value={value} onChange={onChange} />
+ * @example
+ * ```tsx
+ * <StatusSingleEditor options={options} value={value} onChange={onChange} />
+ * ```
  */
 declare const StatusSingleEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: FilterEditorRendererProps<string>) => _emotion_react_jsx_runtime.JSX.Element;
 
 /**
  * Renders a text input field for filtering
- * @example <TextEditor ariaLabel="Search" value={value} onChange={onChange} />
+ * @example
+ * ```tsx
+ * <TextEditor ariaLabel="Search" value={value} onChange={onChange} />
+ * ```
  */
 declare const TextEditor: ({ onChange, ariaLabel, value, readOnly, valueTestId, }: FilterEditorRendererProps<string>) => _emotion_react_jsx_runtime.JSX.Element;
 
@@ -1773,11 +1847,11 @@ declare const TextMultiChoiceEditor: ({ value, disabled, readOnly, valueTestId,
 
 type FilterButtonProps = {
     /** text to display on the button
-     * @default "Filters"
+     * @defaultValue "Filters"
      */
     text?: string;
     /** icon to display on the button
-     * @default "filter-add"
+     * @defaultValue "filter-add"
      */
     icon?: IconType;
     /** number of filters to display on the button and sets the styles on the button */
@@ -1791,13 +1865,19 @@ type FilterButtonProps = {
 } & ButtonHTMLAttributes<HTMLButtonElement>;
 /**
  * A filter button component used to display filter menu options
- * @example <FilterButton text="Filters" filterCount={3} />
+ * @example
+ * ```tsx
+ * <FilterButton text="Filters" filterCount={3} />
+ * ```
  */
 declare const FilterButton: ({ text, icon, filterCount, hasSelectedValue, dataTestId, showDropdownIcon, ...props }: FilterButtonProps) => _emotion_react_jsx_runtime.JSX.Element;
 
 /**
  * Default filter controls for search and filter
- * @example <FilterControls />
+ * @example
+ * ```tsx
+ * <FilterControls />
+ * ```
  */
 declare const FilterControls: ({ children, hideSearchInput, }: {
     /** optional param to allow you to add your own controls */
@@ -1808,7 +1888,10 @@ declare const FilterControls: ({ children, hideSearchInput, }: {
 
 /**
  * Renders a filter editor component
- * @example <FilterEditorRenderer editorType="multiChoice" options={options} value={value} onChange={onChange} />
+ * @example
+ * ```tsx
+ * <FilterEditorRenderer editorType="multiChoice" options={options} value={value} onChange={onChange} />
+ * ```
  */
 declare const FilterEditorRenderer: ({ editorType, ...props }: FilterEditorRendererProps<never>) => _emotion_react_jsx_runtime.JSX.Element;
 /** A mapper for filter editor components */
@@ -1854,9 +1937,7 @@ type SearchAndFilterProviderProps = {
     onChange: (filters: Filter[]) => void;
     /** Sets default value for full text search input, useful for bindable search */
     defaultSearchTerm?: string;
-    /** sets the reset filter values
-     * @default "[{ field: '', operator: '', value: '' }]"
-     */
+    /** sets the reset filter values */
     resetFilterValues?: Filter[];
     /** sets the list of filter options for each filter row */
     filterOptions: FilterOptionGroup[];
@@ -1908,11 +1989,17 @@ type SearchAndFilterContextProps = {
 declare const SearchAndFilterContext: React$1.Context<SearchAndFilterContextProps>;
 /**
  * Search and filter provider
- * @example <SearchAndFilterProvider filters={filters} filterOptions={filterOptions} onSearchChange={onSearchChange} onChange={onChange}>Children</SearchAndFilterProvider>
+ * @example
+ * ```tsx
+ * <SearchAndFilterProvider filters={filters} filterOptions={filterOptions} onSearchChange={onSearchChange} onChange={onChange}>Children</SearchAndFilterProvider>
+ * ```
  * */
 declare const SearchAndFilterProvider: ({ filters, filterOptions, filterVisible, alwaysVisible, defaultSearchTerm, onSearchChange, onChange, resetFilterValues, onResetFilterValues, totalResults, isLoading, filterMapper, children, allowBindingSearchTerm, }: SearchAndFilterProviderProps) => _emotion_react_jsx_runtime.JSX.Element;
 /** Search and filter hook
- * @example const { searchTerm, setSearchTerm, filterVisibility, setFilterVisibility, filters, setFilters, handleAddFilter, handleResetFilters, handleDeleteFilter, filterOptions, validFilterQuery } = useSearchAndFilter();
+ * @example
+ * ```tsx
+ * const { searchTerm, setSearchTerm, filterVisibility, setFilterVisibility, filters, setFilters, handleAddFilter, handleResetFilters, handleDeleteFilter, filterOptions, validFilterQuery } = useSearchAndFilter();
+ * ```
  */
 declare const useSearchAndFilter: () => {
     /** the search term value */
@@ -1949,7 +2036,7 @@ declare const useSearchAndFilter: () => {
 
 type SearchAndFilterProps = Omit<SearchAndFilterProviderProps, 'children'> & {
     /** The filter controls to be displayed
-     * @default '<FilterControls />'
+     * @defaultValue '<FilterControls />'
      */
     filterControls?: React$1.ReactNode;
     /** sets the filter mode */
@@ -1961,7 +2048,7 @@ type SearchAndFilterProps = Omit<SearchAndFilterProviderProps, 'children'> & {
     /** Whether data is currently loading */
     isLoading?: boolean;
     /** The results container view
-     * @default '<SearchAndFilterResultContainer />'
+     * @defaultValue '<SearchAndFilterResultContainer />'
      */
     resultsContainerView?: React$1.ReactNode;
     /** sets the reset filter values */
@@ -1975,7 +2062,10 @@ type SearchAndFilterProps = Omit<SearchAndFilterProviderProps, 'children'> & {
 };
 /**
  * Search and filter component
- * @example <SearchAndFilter filters={filters} filterOptions={filterOptions} onChange={onChange} onSearchChange={onSearchChange} onSearchReset={onSearchReset} totalResults={totalResults} />
+ * @example
+ * ```tsx
+ * <SearchAndFilter filters={filters} filterOptions={filterOptions} onChange={onChange} onSearchChange={onSearchChange} onSearchReset={onSearchReset} totalResults={totalResults} />
+ * ```
  * */
 declare const SearchAndFilter: ({ filters, filterOptions, filterVisible, filterControls, viewSwitchControls, resultsContainerView, filterMapper, additionalFiltersContainer, onChange, defaultSearchTerm, onSearchChange, totalResults, isLoading, allowBindingSearchTerm, resetFilterValues, onResetFilterValues, }: SearchAndFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
 
@@ -1998,7 +2088,10 @@ type SearchAndFilterOptionsContainerProps = {
 };
 /**
  * A container component for search and filter options
- * @example <SearchAndFilterOptionsContainer buttonRow={<button>Button</button>}>Children</SearchAndFilterOptionsContainer>
+ * @example
+ * ```tsx
+ * <SearchAndFilterOptionsContainer buttonRow={<button>Button</button>}>Children</SearchAndFilterOptionsContainer>
+ * ```
  * */
 declare const SearchAndFilterOptionsContainer: ({ buttonRow, additionalFiltersContainer, children, }: SearchAndFilterOptionsContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
 type FiltersProps = {
@@ -2013,20 +2106,23 @@ type FiltersProps = {
     /** Sets the data-test-id attribute for the filter menu */
     dataTestId?: string;
     /** The text for the reset button
-     * @default 'reset'
+     * @defaultValue 'reset'
      */
     resetButtonText?: string;
     additionalFiltersContainer?: SearchAndFilterProps['additionalFiltersContainer'];
 };
 /**
  * A filter menu component used to display filter options
- * @example <FilterMenu id="search-and-filter-options">Children</FilterMenu>
+ * @example
+ * ```tsx
+ * <FilterMenu id="search-and-filter-options">Children</FilterMenu>
+ * ```
  * */
 declare const FilterMenu: ({ id, filterTitle, menuControls, additionalFiltersContainer, children, dataTestId, resetButtonText, }: FiltersProps) => _emotion_react_jsx_runtime.JSX.Element;
 
 type SearchAndFilterResultContainerProps = {
     /** The label for the clear button
-     * @default 'Clear'
+     * @defaultValue 'Clear'
      */
     clearButtonLabel?: string;
     /** The text for the button */
@@ -2046,7 +2142,7 @@ declare const SearchAndFilterResultContainer: ({ buttonText, clearButtonLabel, c
 declare const SearchOnlyContext: React$1.Context<Pick<SearchAndFilterContextProps, "searchTerm" | "setSearchTerm">>;
 type SearchOnlyProviderProps = Pick<SearchAndFilterProviderProps, 'onSearchChange'> & {
     /** sets the max width of input wrapper
-     * @default '712px'
+     * @defaultValue '712px'
      */
     maxWidth?: string;
 };
@@ -2054,11 +2150,11 @@ declare const SearchOnlyFilter: ({ onSearchChange, maxWidth }: SearchOnlyProvide
 
 type SortItemsProps = {
     /** The label for the sort by field
-     * @default 'Sort by'
+     * @defaultValue 'Sort by'
      */
     sortByLabel?: string;
     /** The label for the locale returned field
-     * @default 'Enabled locale'
+     * @defaultValue 'Enabled locale'
      */
     localeLabel?: string;
     /** sets the list of sort options */
@@ -2150,8 +2246,8 @@ declare function useUniformMeshSdk(): _uniformdev_mesh_sdk.UniformMeshSDK;
 /**
  * Creates a validation interceptor between useMeshLocation's setValue function and your code.
  * You can use this utility to write cleaner validation logic for your Mesh Location UIs.
- * @param setValue The location's raw setValue function
- * @param validate A function to validate the new location's value.
+ * @param setValue - The location's raw setValue function
+ * @param validate - A function to validate the new location's value.
  * @returns An equivalent to the setValue function that intercepts sets, performs validation, and emits the result with the new value.
  */
 declare function createLocationValidator<TSetValue>(setValue: SetLocationValueDispatch<TSetValue>, validate: (newValue: TSetValue, currentResult: SetValueOptions | undefined) => SetValueOptions): SetLocationValueDispatch<TSetValue>;
@@ -2160,7 +2256,11 @@ type ContentDataResourceLocaleInfoResult = {
     /**
      * Effective locale for data resource. It can be one of two types:
      * - raw locale string - locale stored in mesh data type/resource (e.g. 'en-US')
-     * - variable reference - locale stored in mesh data type/resource as a variable reference (e.g. '${locale}')
+     * - variable reference - locale stored in mesh data type/resource as a variable reference
+     * @example
+     * ```
+     * ${locale}
+     * ```
      */
     effectiveLocale: string;
     /** Bound locale value. It can be one of two types:
@@ -2174,7 +2274,11 @@ type ContentDataResourceLocaleInfoProps = {
      * It can be one of tree types:
      *  - undefined - no locale stored in mesh data type/resource yet or it is not localized
      *  - raw locale string - locale stored in mesh data type/resource (e.g. 'en-US')
-     *  - variable reference - locale stored in mesh data type/resource as a variable reference (e.g. '${locale}')
+     *  - variable reference - locale stored in mesh data type/resource as a variable reference
+     * @example
+     * ```
+     * ${locale}
+     * ```
      *
      *  If locale is empty, fallback to dynamic locale value if it is available.
      */
@@ -2183,7 +2287,7 @@ type ContentDataResourceLocaleInfoProps = {
     defaultLocale: string | undefined;
     /** Map of dynamic inputs for current composition. Should be passed down from DataResource metadata */
     dynamicInputs: DynamicInputs;
-    /** In case of empty locale value, this method is called to bind dynamic locale (sets locale to '${locale}') */
+    /** In case of empty locale value, this method is called to bind dynamic locale */
     setLocale?: (locale: string) => void;
 };
 declare function useContentDataResourceLocaleInfo({ locale, defaultLocale, setLocale, dynamicInputs, }: ContentDataResourceLocaleInfoProps): ContentDataResourceLocaleInfoResult;