IAttributeFilterCustomComponentProps
These customization properties allow you to specify custom components that the AttributeFilter component will use for rendering different parts.
export interface IAttributeFilterCustomComponentProps
Remarks
IMPORTANT: while this interface is marked as public, you also need to heed the maturity annotations on each Customization properties,that are at this moment beta level.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
ComponentType<IAttributeFilterDropdownActionsProps> | (BETA) (Optional) Customize attribute filter dropdown actions component. | ||
ComponentType<IAttributeFilterDropdownBodyProps> | (BETA) (Optional) Customize attribute filter dropdown body component. | ||
ComponentType<IAttributeFilterDropdownButtonProps> | (BETA) (Optional) Customize attribute filter dropdown button component. | ||
ComponentType<IAttributeFilterElementsSearchBarProps> | (BETA) (Optional) Customize attribute filter search bar component. | ||
ComponentType<IAttributeFilterElementsActionsProps> | (BETA) (Optional) Customize attribute filter elements select action component (Select all checkbox) | ||
ComponentType<IAttributeFilterElementsSelectProps> | (BETA) (Optional) Customize attribute filter elements select component. | ||
ComponentType<IAttributeFilterElementsSelectErrorProps> | (BETA) (Optional) Customize attribute filter elements select error component. | ||
ComponentType<IAttributeFilterElementsSelectItemProps> | (BETA) (Optional) Customize attribute filter elements select item component. | ||
ComponentType<IAttributeFilterElementsSelectLoadingProps> | (BETA) (Optional) Customize attribute filter elements select loading component. | ||
ComponentType<IAttributeFilterEmptyResultProps> | (BETA) (Optional) Customize attribute filter empty result component. | ||
ComponentType<IAttributeFilterErrorProps> | (BETA) (Optional) Customize attribute filter with a component to be rendered if initialization fails. | ||
ComponentType<IFilterMenuProps> | (ALPHA) (Optional) Customize filter mode menu component. | ||
ComponentType<IAttributeFilterLoadingProps> | (BETA) (Optional) Customize attribute filter with a component to be rendered if attribute filter is loading. Note that this will be rendered only during the initialization of the attribute filter. | ||
ComponentType<IAttributeFilterStatusBarProps> | (BETA) (Optional) Customize attribute filter status bar component. | ||
ComponentType<ITextFilterBodyProps> | (ALPHA) (Optional) Customize text filter body component. |
Property details
IAttributeFilterCustomComponentProps.DropdownActionsComponentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Customize attribute filter dropdown actions component.
DropdownActionsComponent?: ComponentType<IAttributeFilterDropdownActionsProps>;
Remarks
- If not provided, the default implementation AttributeFilterDropdownActions() will be used.
IAttributeFilterCustomComponentProps.DropdownBodyComponentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Customize attribute filter dropdown body component.
DropdownBodyComponent?: ComponentType<IAttributeFilterDropdownBodyProps>;
Remarks
- If not provided, the default implementation AttributeFilterDropdownBody() will be used.
IAttributeFilterCustomComponentProps.DropdownButtonComponentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Customize attribute filter dropdown button component.
DropdownButtonComponent?: ComponentType<IAttributeFilterDropdownButtonProps>;
Remarks
- If not provided, the default implementation AttributeFilterDropdownButton() or AttributeFilterSimpleDropdownButton() will be used.
IAttributeFilterCustomComponentProps.ElementsSearchBarComponentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Customize attribute filter search bar component.
ElementsSearchBarComponent?: ComponentType<IAttributeFilterElementsSearchBarProps>;
Remarks
- If not provided, the default implementation AttributeFilterElementsSearchBar() will be used.
IAttributeFilterCustomComponentProps.ElementsSelectActionsComponentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Customize attribute filter elements select action component (Select all checkbox)
ElementsSelectActionsComponent?: ComponentType<IAttributeFilterElementsActionsProps>;
Remarks
- If not provided, the default implementation AttributeFilterElementsActions() will be used.
IAttributeFilterCustomComponentProps.ElementsSelectComponentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Customize attribute filter elements select component.
ElementsSelectComponent?: ComponentType<IAttributeFilterElementsSelectProps>;
Remarks
- If not provided, the default implementation AttributeFilterElementsSelect() will be used.
IAttributeFilterCustomComponentProps.ElementsSelectErrorComponentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Customize attribute filter elements select error component.
ElementsSelectErrorComponent?: ComponentType<IAttributeFilterElementsSelectErrorProps>;
Remarks
- If not provided, the default implementation AttributeFilterElementsSelectError() will be used.
IAttributeFilterCustomComponentProps.ElementsSelectItemComponentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Customize attribute filter elements select item component.
ElementsSelectItemComponent?: ComponentType<IAttributeFilterElementsSelectItemProps>;
Remarks
- If not provided, the default implementation AttributeFilterElementsSelectItem() will be used.
IAttributeFilterCustomComponentProps.ElementsSelectLoadingComponentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Customize attribute filter elements select loading component.
ElementsSelectLoadingComponent?: ComponentType<IAttributeFilterElementsSelectLoadingProps>;
Remarks
- If not provided, the default implementation AttributeFilterElementsSelectLoading() will be used.
IAttributeFilterCustomComponentProps.EmptyResultComponentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Customize attribute filter empty result component.
EmptyResultComponent?: ComponentType<IAttributeFilterEmptyResultProps>;
Remarks
- If not provided, the default implementation AttributeFilterEmptyResult() will be used.
IAttributeFilterCustomComponentProps.ErrorComponentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Customize attribute filter with a component to be rendered if initialization fails.
ErrorComponent?: ComponentType<IAttributeFilterErrorProps>;
Remarks
- If not provided, the default implementation AttributeFilterError() will be used.
IAttributeFilterCustomComponentProps.FilterMenuComponentpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Customize filter mode menu component.
FilterMenuComponent?: ComponentType<IFilterMenuProps>;
Remarks
- If not provided, the default implementation FilterMenu() will be used.
IAttributeFilterCustomComponentProps.LoadingComponentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Customize attribute filter with a component to be rendered if attribute filter is loading. Note that this will be rendered only during the initialization of the attribute filter.
LoadingComponent?: ComponentType<IAttributeFilterLoadingProps>;
Remarks
- If not provided, the default implementation AttributeFilterLoading() will be used.
IAttributeFilterCustomComponentProps.StatusBarComponentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Customize attribute filter status bar component.
StatusBarComponent?: ComponentType<IAttributeFilterStatusBarProps>;
Remarks
- If not provided, the default implementation AttributeFilterStatusBar() will be used.
IAttributeFilterCustomComponentProps.TextFilterBodyComponentpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Customize text filter body component.
TextFilterBodyComponent?: ComponentType<ITextFilterBodyProps>;
Remarks
- If not provided, the default implementation TextFilterBody() will be used.