Skip to content

Commit a4a22ce

Browse files
authored
chore: Add new props to property filter api docs (#3900)
1 parent dcd0276 commit a4a22ce

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

src/__tests__/snapshot-tests/__snapshots__/documenter.test.ts.snap

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19017,6 +19017,8 @@ See the [Autosuggest API](/components/autosuggest/?tabId=api) page for more deta
1901719017
* \`propertyKey\` [string]: The key of the corresponding filtering property in the \`filteringProperties\` array.
1901819018
* \`value\` [string]: The value that will be used as a suggestion when creating or modifying a filtering token.
1901919019
* \`label\` [string]: Optional suggestion label to be matched instead of the value.
19020+
* \`tags\` [string[]]: Optional list of tags giving further guidance about the option.
19021+
* \`filteringTags\` [string[]]: Optional list of additional tags used for automatic filtering.
1902019022

1902119023
Filtering options that require labels can only use \`=\` and \`!=\` operators. The token value must be labelled separately, for example:
1902219024
\`\`\`

src/property-filter/interfaces.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,8 @@ export interface PropertyFilterProps extends BaseComponentProps, ExpandToViewpor
106106
* * `propertyKey` [string]: The key of the corresponding filtering property in the `filteringProperties` array.
107107
* * `value` [string]: The value that will be used as a suggestion when creating or modifying a filtering token.
108108
* * `label` [string]: Optional suggestion label to be matched instead of the value.
109+
* * `tags` [string[]]: Optional list of tags giving further guidance about the option.
110+
* * `filteringTags` [string[]]: Optional list of additional tags used for automatic filtering.
109111
*
110112
* Filtering options that require labels can only use `=` and `!=` operators. The token value must be labelled separately, for example:
111113
* ```

0 commit comments

Comments
 (0)