components
components copied to clipboard
docs(property-filter): Improve documentation of `defaultOperator`
Description
Improving some of the documentation of Property filter. When the default Equals operator ("=") is excluded from the list of operators
, customers need to also specify a new defaultOperator
. The motivation with this change is to make that dependency more clear.
Before (see https://cloudscape.design/components/property-filter/?tabId=api):
- operators [Array]: A list of all operators supported by this property. Equals operator should always be supported, even if you omit it in the list.
- defaultOperator [ComparisonOperator]: Optional parameter that changes the default operator used with this filtering property. Use it only if your API does not support "equals" filtering terms with this property.
After:
- operators [Array]: A list of all operators supported by this property. If you omit the equals operator because your API does not support it, make sure to set
defaultOperator
to a supported operator from this list.- defaultOperator [ComparisonOperator]: Optional parameter that changes the default operator used with this filtering property. Use it only if your API does not support "equals" filtering terms with this property.
Changes in bold. This replaces the old sentence which was slightly misleading.
How has this been tested?
It's just a documentation change.
Documentation changes
[Do the changes include any API documentation changes?]
- [x] Yes, this change contains documentation changes.
- [ ] No.
Related Links
[Attach any related links/pull request for this change]
Review checklist
The following items are to be evaluated by the author(s) and the reviewer(s).
Correctness
- [ ] Changes are backward-compatible if not indicated, see
CONTRIBUTING.md
. - [ ] Changes do not include unsupported browser features, see
CONTRIBUTING.md
. - [ ] Changes were manually tested for accessibility, see accessibility guidelines.
Security
- [ ] If the code handles URLs: all URLs are validated through the
checkSafeUrl
function.
Testing
- [ ] Changes are covered with new/existing unit tests?
- [ ] Changes are covered with new/existing integration tests?
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.