NcCheckboxContent.vue

<!--
  - SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
  - SPDX-License-Identifier: AGPL-3.0-or-later
-->

<template>
	<span
		class="checkbox-content"
		:class="{
			['checkbox-content-' + type]: true,
			'checkbox-content--button-variant': buttonVariant,
			'checkbox-content--has-text': !!$slots.default,
		}">
		<!--
			label can't be used here because of shift+click firefox bug
			https://bugzilla.mozilla.org/show_bug.cgi?id=559506
		-->
		<span
			class="checkbox-content__icon"
			:class="{
				'checkbox-content__icon--checked': isChecked,
				[iconClass]: true,
			}"
			:aria-hidden="true"
			inert>
			<!-- @slot The checkbox/radio icon, you can use it for adding an icon to the button variant
					@binding {bool} checked The input checked state
					@binding {bool} loading The loading state
			-->
			<slot
				name="icon"
				:checked="isChecked"
				:loading="loading">
				<NcLoadingIcon v-if="loading" />
				<NcIconToggleSwitch
					v-else-if="isSwitchType"
					:checked="isChecked"
					:size="iconSize"
					inline />
				<component
					:is="checkboxRadioIconElement"
					v-else-if="!buttonVariant"
					:size="iconSize" />
			</slot>
		</span>

		<span v-if="$slots.default || $slots.description" class="checkbox-content__wrapper">
			<span
				v-if="$slots.default"
				:id="labelId"
				class="checkbox-content__text"
				:class="textClass">
				<!-- @slot The checkbox/radio label -->
				<slot />
			</span>
			<span v-if="!isButtonType && $slots.description" :id="descriptionId" class="checkbox-content__description">
				<slot name="description" />
			</span>
		</span>
	</span>
</template>

<script>
import CheckboxBlankOutline from 'vue-material-design-icons/CheckboxBlankOutline.vue'
import CheckboxMarked from 'vue-material-design-icons/CheckboxMarked.vue'
import MinusBox from 'vue-material-design-icons/MinusBox.vue'
import RadioboxBlank from 'vue-material-design-icons/RadioboxBlank.vue'
import RadioboxMarked from 'vue-material-design-icons/RadioboxMarked.vue'
import NcIconToggleSwitch from '../NcIconToggleSwitch/NcIconToggleSwitch.vue'
import NcLoadingIcon from '../NcLoadingIcon/index.js'

export const TYPE_CHECKBOX = 'checkbox'
export const TYPE_RADIO = 'radio'
export const TYPE_SWITCH = 'switch'
export const TYPE_BUTTON = 'button'

export default {
	name: 'NcCheckboxContent',

	components: {
		NcLoadingIcon,
		NcIconToggleSwitch,
	},

	props: {
		/**
		 * Class for the icon element
		 */
		iconClass: {
			type: [String, Object],
			default: null,
		},

		/**
		 * Class for the text element
		 */
		textClass: {
			type: [String, Object],
			default: null,
		},

		/**
		 * Type of the input. checkbox, radio, switch, or button.
		 *
		 * Only use button when used in a `tablist` container and the
		 * `tab` role is set.
		 *
		 * @type {'checkbox'|'radio'|'switch'|'button'}
		 */
		type: {
			type: String,
			default: 'checkbox',
			validator: (type) => [
				TYPE_CHECKBOX,
				TYPE_RADIO,
				TYPE_SWITCH,
				TYPE_BUTTON,
			].includes(type),
		},

		/**
		 * Toggle the alternative button style
		 */
		buttonVariant: {
			type: Boolean,
			default: false,
		},

		/**
		 * True if the entry is checked
		 */
		isChecked: {
			type: Boolean,
			default: false,
		},

		/**
		 * Indeterminate state
		 */
		indeterminate: {
			type: Boolean,
			default: false,
		},

		/**
		 * Loading state
		 */
		loading: {
			type: Boolean,
			default: false,
		},

		/**
		 * Icon size
		 */
		iconSize: {
			type: Number,
			default: 24,
		},

		/**
		 * Label id attribute
		 */
		labelId: {
			type: String,
			required: true,
		},

		/**
		 * Description id attribute
		 */
		descriptionId: {
			type: String,
			required: true,
		},
	},

	computed: {
		isButtonType() {
			return this.type === TYPE_BUTTON
		},

		isSwitchType() {
			return this.type === TYPE_SWITCH
		},

		/**
		 * Returns the proper Material icon depending on the select case
		 *
		 * @return {object}
		 */
		checkboxRadioIconElement() {
			if (this.type === TYPE_RADIO) {
				if (this.isChecked) {
					return RadioboxMarked
				}
				return RadioboxBlank
			}

			// Checkbox
			if (this.indeterminate) {
				return MinusBox
			}
			if (this.isChecked) {
				return CheckboxMarked
			}
			return CheckboxBlankOutline
		},
	},
}
</script>

<style lang="scss" scoped>
.checkbox-content {
	display: flex;
	align-items: center;
	flex-direction: row;
	gap: var(--default-grid-baseline);
	user-select: none;
	min-height: var(--default-clickable-area);
	border-radius: var(--checkbox-radio-switch--border-radius);
	padding: var(--default-grid-baseline) calc((var(--default-clickable-area) - var(--icon-height)) / 2);
	// Set to 100% to make text overflow work on button style
	width: 100%;
	// but restrict to content so plain checkboxes / radio switches do not expand
	max-width: fit-content;

	&__wrapper {
		flex: 1 0;
	}

	&__text {

		&:empty {
			// hide text if empty to ensure checkbox outline is a circle instead of oval
			display: none;
		}
	}

	&-checkbox:not(&--button-variant) &__icon,
	&-radio:not(&--button-variant) &__icon,
	&-switch:not(&--button-variant) &__icon {
		margin-block: calc((var(--default-clickable-area) - 2 * var(--default-grid-baseline) - var(--icon-height)) / 2) auto;
		line-height: 0;
	}

	&-checkbox:not(&--button-variant) &__icon--has-description,
	&-radio:not(&--button-variant) &__icon--has-description,
	&-switch:not(&--button-variant) &__icon--has-description {
		display: flex;
		align-items: center;
		margin-block-end: 0;
		align-self: start;
	}

	&__icon > * {
		width: var(--icon-size);
		height: var(--icon-height);
		color: var(--color-primary-element);
	}

	&__description {
		display: block;
		color: var(--color-text-maxcontrast);
		font-weight: var(--font-weight-default, normal);
	}

	&--button-variant {
		.checkbox-content__icon:not(.checkbox-content__icon--checked) > * {
			color: var(--color-primary-element);
		}

		.checkbox-content__icon--checked > * {
			color: var(--color-primary-element-text);
		}
	}

	&--has-text {
		padding-right: $icon-margin;
	}

	&, * {
		cursor: pointer;
		flex-shrink: 0;
	}
}
</style>