Skip to content
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

Feat/dsfr select hint #985

Merged
merged 2 commits into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/components/DsfrNavigation/DsfrNavigationItem.spec.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
import { render } from '@testing-library/vue'
// import '@gouvfr/dsfr/dist/core/core.module.js'
import { useId } from 'vue'

import DsfrNavigationItem from './DsfrNavigationItem.vue'

describe('DsfrNavigationItem', () => {
it('should render a navigation item', () => {
const content = 'Contenu d’un item de menu de navigation'
const id = useId()
const id = 'dsfr-id'
Comment on lines -10 to +9
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Je ne suis pas contre ce changement, cependant pourquoi dans cette PR ?

Copy link
Collaborator Author

@iNeoO iNeoO Nov 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

il bloque le push (les tests ne passent pas)

const { getByText } = render(DsfrNavigationItem, {
props: {
id,
Expand Down
27 changes: 14 additions & 13 deletions src/components/DsfrSelect/DsfrSelect.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,20 @@ La liste déroulante fournit une liste d’option parmi lesquelles l’utilisate

## 🛠️ Props

| Nom | Type | Défaut | Obligatoire | Description |
|-------------------------|---------------------------------------------------------------------------------------------|-----------------------------|:-----------:|------------------------------------------------------------------|
| `modelValue` | `string \| number` | | | Valeur associée à l'option sélectionnée. |
| `required` | `boolean` | | | Indique si le select est obligatoire. |
| `disabled` | `boolean` | | | Indique si le select est désactivé. |
| `options` | `(string \| undefined \| { value: string \| undefined, text: string disabled?: boolean})[]` | `[]` | | Options à sélectionner |
| `label` | `string` | `''` | | Texte du label associé au select. |
| `name` | `string` | | | Nom du champ. |
| `description` | `string` | | | Si `true`, l'infobulle s'affiche au survol. |
| `successMessage` | `string` | `''` | | Message de validation à afficher en dessous du select. |
| `errorMessage` | `string` | `''` | | Message d'erreur à afficher en dessous du select. |
| `defaultUnselectedText` | `string` | `'Sélectionner une option'` | | Si `true`, l'infobulle s'affiche au survol. |
| `selectId` | `string` | `getRandomId('select')` | | Identifiant unique pour le select. Utilisé pour l'accessibilité. |
| Nom | Type | Défaut | Obligatoire | Description |
|--------------------------|---------------------------------------------------------------------------------------------|-----------------------------|:-----------:|------------------------------------------------------------------|
| `modelValue` | `string \| number` | | | Valeur associée à l'option sélectionnée. |
| `required` | `boolean` | | | Indique si le select est obligatoire. |
| `disabled` | `boolean` | | | Indique si le select est désactivé. |
| `options` | `(string \| undefined \| { value: string \| undefined, text: string disabled?: boolean})[]` | `[]` | | Options à sélectionner |
| `label` | `string` | `''` | | Texte du label associé au select. |
| `name` | `string` | | | Nom du champ. |
| `description` deprecated | `string` | | | Deprecated, utiliser hint plutôt. |
| `hint` | `string` | | | Texte d'indice pour guider. |
| `successMessage` | `string` | `''` | | Message de validation à afficher en dessous du select. |
| `errorMessage` | `string` | `''` | | Message d'erreur à afficher en dessous du select. |
| `defaultUnselectedText` | `string` | `'Sélectionner une option'` | | Si `true`, l'infobulle s'affiche au survol. |
| `selectId` | `string` | `getRandomId('select')` | | Identifiant unique pour le select. Utilisé pour l'accessibilité. |

## 📡 Évenements

Expand Down
1 change: 1 addition & 0 deletions src/components/DsfrSelect/DsfrSelect.types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export type DsfrSelectProps = {
selectId?: string
name?: string
description?: string
hint?: string
modelValue?: DsfrSelectOption
label?: string
options?: (DsfrSelectOption | { value: DsfrSelectOption, text: string, disabled?: boolean })[]
Expand Down
11 changes: 9 additions & 2 deletions src/components/DsfrSelect/DsfrSelect.vue
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,20 @@ const props = withDefaults(defineProps<DsfrSelectProps>(), {
label: '',
name: undefined,
description: undefined,
hint: undefined,
successMessage: '',
errorMessage: '',
defaultUnselectedText: 'Sélectionner une option',
})

defineEmits<{ (e: 'update:modelValue', payload: string | number): void }>()

if (props.description) {
console.warn(
'[DsfrSelect] : La prop `description` est dépréciée. Veuillez utiliser `hint` à la place.',
)
}

const message = computed(() => {
return props.errorMessage || props.successMessage
})
Expand Down Expand Up @@ -55,9 +62,9 @@ const messageType = computed(() => {
</slot>

<span
v-if="description"
v-if="hint ?? description"
class="fr-hint-text"
>{{ description }}</span>
>{{ hint ?? description }}</span>
</label>

<select
Expand Down
Loading