-
Notifications
You must be signed in to change notification settings - Fork 6
feat: search custom filters #1048
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
Open
ThibaudDauce
wants to merge
4
commits into
main
Choose a base branch
from
search-custom-filters
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| <template> | ||
| <div class="fr-input-group"> | ||
| <label | ||
| for="theme-filter" | ||
| class="fr-label" | ||
| > | ||
| Thème (custom filter) | ||
| </label> | ||
| <select | ||
| id="theme-filter" | ||
| v-model="value" | ||
| class="fr-select shadow-input-blue!" | ||
| > | ||
| <option :value="undefined"> | ||
| Tous les thèmes | ||
| </option> | ||
| <option | ||
| v-for="theme in themes" | ||
| :key="theme.value" | ||
| :value="theme.value" | ||
| > | ||
| {{ theme.label }} | ||
| </option> | ||
| </select> | ||
| </div> | ||
| </template> | ||
|
|
||
| <script setup lang="ts"> | ||
| import { useSearchFilter } from '@datagouv/components-next' | ||
|
|
||
| const themes = [ | ||
| { value: 'environnement', label: 'Environnement' }, | ||
| { value: 'transport', label: 'Transport' }, | ||
| { value: 'sante', label: 'Santé' }, | ||
| { value: 'education', label: 'Éducation' }, | ||
| { value: 'logement', label: 'Logement' }, | ||
| ] | ||
|
|
||
| // ?theme=environnement dans l'URL → tag=environnement dans l'API | ||
| const value = useSearchFilter('theme', { apiParam: 'tag' }) | ||
| </script> |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| import { type InjectionKey, type Ref, inject, onScopeDispose } from 'vue' | ||
| import { useRouteQuery } from '@vueuse/router' | ||
|
|
||
| export interface CustomFilterEntry { | ||
| apiParam: string | ||
| ref: Ref<string | undefined> | ||
| defaultValue: string | undefined | ||
| } | ||
|
|
||
| export interface SearchFilterContext { | ||
| register(urlParam: string, entry: CustomFilterEntry): void | ||
| unregister(urlParam: string): void | ||
| } | ||
|
|
||
| export const searchFilterContextKey: InjectionKey<SearchFilterContext> | ||
| = Symbol('SearchFilterContext') | ||
|
|
||
| export interface UseSearchFilterOptions { | ||
| /** The API parameter name to map this filter to. Defaults to the urlParam. */ | ||
| apiParam?: string | ||
| /** Default value when not present in URL. Defaults to undefined. */ | ||
| defaultValue?: string | ||
| } | ||
|
|
||
| /** | ||
| * Registers a custom filter with the parent GlobalSearch component. | ||
| * | ||
| * Must be called inside a component rendered within GlobalSearch's `#custom-filters` slot. | ||
| * | ||
| * @param urlParam - The URL query parameter name (e.g. 'theme' → `?theme=value`) | ||
| * @param options - Optional: `apiParam` to map to a different API param (e.g. 'tag'), `defaultValue` | ||
| * @returns A reactive ref bound to the URL parameter, suitable for v-model | ||
| * | ||
| * @example | ||
| * ```vue | ||
| * <script setup> | ||
| * import { useSearchFilter } from '@datagouv/components-next' | ||
| * // URL: ?theme=environment → API: ?tag=environment | ||
| * const value = useSearchFilter('theme', { apiParam: 'tag' }) | ||
| * </script> | ||
| * ``` | ||
| */ | ||
| export function useSearchFilter( | ||
| urlParam: string, | ||
| options: UseSearchFilterOptions = {}, | ||
| ): Ref<string | undefined> { | ||
| const context = inject(searchFilterContextKey) | ||
| if (!context) { | ||
| throw new Error( | ||
| `useSearchFilter("${urlParam}") must be used inside a <GlobalSearch> component.`, | ||
| ) | ||
| } | ||
|
|
||
| const { apiParam = urlParam, defaultValue = undefined } = options | ||
|
|
||
| const value = useRouteQuery<string | undefined>(urlParam, defaultValue) | ||
|
|
||
| context.register(urlParam, { apiParam, ref: value, defaultValue }) | ||
|
|
||
| onScopeDispose(() => { | ||
| value.value = defaultValue | ||
| context.unregister(urlParam) | ||
| }) | ||
|
|
||
| return value | ||
| } |
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
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.