chore(Toggle)!: rename icons to onIcon / offIcon for consistency

This commit is contained in:
Benjamin Canac
2023-05-29 21:38:51 +02:00
parent 1ebaa5aa00
commit 8ee2ac10e7
3 changed files with 15 additions and 15 deletions

View File

@@ -13,16 +13,16 @@ headlessui:
### Icon ### Icon
Use any icon from [Iconify](https://icones.js.org) by setting the `icon-on` and `icon-off` props by using this pattern: `i-{collection_name}-{icon_name}`. Use any icon from [Iconify](https://icones.js.org) by setting the `on-icon` and `off-icon` props by using this pattern: `i-{collection_name}-{icon_name}` or change it globally in `ui.toggle.default.onIcon` and `ui.toggle.default.offIcon`.
::component-card ::component-card
--- ---
props: props:
iconOn: 'i-heroicons-check-20-solid' onIcon: 'i-heroicons-check-20-solid'
iconOff: 'i-heroicons-x-mark-20-solid' offIcon: 'i-heroicons-x-mark-20-solid'
excludedProps: excludedProps:
- iconOn - onIcon
- iconOff - offIcon
--- ---
:: ::

View File

@@ -439,8 +439,8 @@ const toggle = {
off: 'h-3 w-3 text-gray-400 dark:text-gray-500' off: 'h-3 w-3 text-gray-400 dark:text-gray-500'
}, },
default: { default: {
iconOn: null, onIcon: null,
iconOff: null offIcon: null
} }
} }

View File

@@ -5,11 +5,11 @@
:class="[active ? ui.active : ui.inactive, ui.base]" :class="[active ? ui.active : ui.inactive, ui.base]"
> >
<span :class="[active ? ui.container.active : ui.container.inactive, ui.container.base]"> <span :class="[active ? ui.container.active : ui.container.inactive, ui.container.base]">
<span v-if="iconOn" :class="[active ? ui.icon.active : ui.icon.inactive, ui.icon.base]" aria-hidden="true"> <span v-if="onIcon" :class="[active ? ui.icon.active : ui.icon.inactive, ui.icon.base]" aria-hidden="true">
<UIcon :name="iconOn" :class="ui.icon.on" /> <UIcon :name="onIcon" :class="ui.icon.on" />
</span> </span>
<span v-if="iconOff" :class="[active ? ui.icon.inactive : ui.icon.active, ui.icon.base]" aria-hidden="true"> <span v-if="offIcon" :class="[active ? ui.icon.inactive : ui.icon.active, ui.icon.base]" aria-hidden="true">
<UIcon :name="iconOff" :class="ui.icon.off" /> <UIcon :name="offIcon" :class="ui.icon.off" />
</span> </span>
</span> </span>
</Switch> </Switch>
@@ -43,13 +43,13 @@ export default defineComponent({
type: Boolean, type: Boolean,
default: false default: false
}, },
iconOn: { onIcon: {
type: String, type: String,
default: () => appConfig.ui.toggle.default.iconOn default: () => appConfig.ui.toggle.default.onIcon
}, },
iconOff: { offIcon: {
type: String, type: String,
default: () => appConfig.ui.toggle.default.iconOff default: () => appConfig.ui.toggle.default.offIcon
}, },
ui: { ui: {
type: Object as PropType<Partial<typeof appConfig.ui.toggle>>, type: Object as PropType<Partial<typeof appConfig.ui.toggle>>,