-
Notifications
You must be signed in to change notification settings - Fork 2.9k
feat: select field filter options #12487
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DanRibbens
reviewed
May 22, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are we married to reduceOptions
, I would prefer to just call it filterOptions?
DanRibbens
approved these changes
May 22, 2025
jacobsfletch
added a commit
that referenced
this pull request
May 27, 2025
You can now specify exactly who can change the constraints within a query preset. For example, you want to ensure that only "admins" are allowed to set a preset to "everyone". To do this, you can use the new `queryPresets.filterConstraints` property. When a user lacks the permission to change a constraint, the option will either be hidden from them or disabled if it is already set. ```ts import { buildConfig } from 'payload' const config = buildConfig({ // ... queryPresets: { // ... filterConstraints: ({ req, options }) => !req.user?.roles?.includes('admin') ? options.filter( (option) => (typeof option === 'string' ? option : option.value) !== 'everyone', ) : options, }, }) ``` The `filterConstraints` functions takes the same arguments as `reduceOptions` property on select fields introduced in #12487.
🚀 This is included in version v3.40.0 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It is a common pattern to dynamically show and validate a select field's options based on various criteria such as the current user or underlying document.
Some examples of this might include:
While this is already possible to do with a custom
validate
function, the user can still view and select the forbidden option...unless you also wired up a custom component.Now, you can define
filterOptions
on select fields.This behaves similarly to the existing
filterOptions
property on relationship and upload fields, except the return value of this function is simply an array of options, not a query constraint. The result of this function will determine what is shown to the user and what is validated on the server.Here's an example: