@nexxtmove/ui 1.21.0 → 1.23.0

package/dist/nuxt.js

@@ -66,11 +66,13 @@ var s = {
 	NexxtVideoPlayer: "components/organisms/VideoPlayer/VideoPlayer.vue",
 	NexxtEditorSettingsBlock: "components/editor/atoms/EditorSettingsBlock/EditorSettingsBlock.vue",
 	NexxtEditorAlignItems: "components/editor/molecules/EditorAlignItems/EditorAlignItems.vue",
+	NexxtEditorColor: "components/editor/molecules/EditorColor/EditorColor.vue",
 	NexxtEditorFlexDirection: "components/editor/molecules/EditorFlexDirection/EditorFlexDirection.vue",
 	NexxtEditorGap: "components/editor/molecules/EditorGap/EditorGap.vue",
+	NexxtEditorHeadingType: "components/editor/molecules/EditorHeadingType/EditorHeadingType.vue",
 	NexxtEditorJustifyContent: "components/editor/molecules/EditorJustifyContent/EditorJustifyContent.vue",
-	NexxtEditorRadius: "components/editor/molecules/EditorRadius/EditorRadius.vue",
-	NexxtEditorPadding: "components/editor/molecules/EditorPadding/EditorPadding.vue"
+	NexxtEditorPadding: "components/editor/molecules/EditorPadding/EditorPadding.vue",
+	NexxtEditorRadius: "components/editor/molecules/EditorRadius/EditorRadius.vue"
 }, c = ["@nexxtmove/ui/ui.css", "@nexxtmove/ui/dist/ui.css"], l = (e, t) => e.some((e) => e === t || c.includes(e)), u = i({
 	meta: {
 		name: "@nexxtmove/ui",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nexxtmove/ui",
   "type": "module",
-  "version": "1.21.0",
+  "version": "1.23.0",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",

package/src/components/editor/molecules/EditorColor/EditorColor.vue

@@ -0,0 +1,155 @@
+<script lang="ts">
+/**
+ * The CSS property the chosen colour is written to. It is the prefix of the
+ * Tailwind class the model carries, so it decides whether the colour becomes a
+ * background or a text colour. `border` is deliberately not offered: a border
+ * is colour plus width, and that pair gets a component of its own.
+ */
+export type EditorColorProperty = 'bg' | 'text'
+
+/**
+ * The colour as the editor needs it: a Tailwind arbitrary-value class such as
+ * `'bg-[#1777EA]'`, so the consumer can put the model value straight on the
+ * element it styles.
+ */
+export type EditorColorValue = `${EditorColorProperty}-[#${string}]`
+
+/** Overridable copy of the picker. Every key is optional. */
+export interface EditorColorMessages {
+  /** Text shown while no colour is set. Defaults to `'Kies kleur...'`. */
+  placeholder?: string
+}
+
+export interface NexxtEditorColorProps {
+  /**
+   * Header text of the settings block. Defaults to the Dutch `'Kleur'`; the
+   * library has no i18n layer, so a consumer in another language passes its
+   * own copy in.
+   */
+  label?: string
+  /**
+   * Render a switch next to the label that collapses and expands the picker.
+   * The switch state is the `enabled` model; the colour itself is kept while
+   * the block is collapsed.
+   */
+  switchable?: boolean
+  /**
+   * The prefix of the class that is written: `'bg'` for a background colour,
+   * `'text'` for a text colour. Changing it rewrites the current value, so the
+   * model never disagrees with this prop.
+   */
+  property?: EditorColorProperty
+  /**
+   * Copy of the picker. Merged per key, so overriding one key keeps the
+   * defaults of the others. Copy is never translated inside the component.
+   */
+  messages?: EditorColorMessages
+}
+
+const DEFAULT_MESSAGES = {
+  placeholder: 'Kies kleur...',
+} satisfies Required<EditorColorMessages>
+
+/**
+ * A full model value: one of the two prefixes, then a 6- or 8-digit hex between
+ * brackets. A `border-[…]` class is therefore read as unparseable, the same as
+ * any other class this component does not own. The
+ * alpha pair is accepted on read so a stored `#1777EA80` survives a round trip,
+ * even though the picker itself is opened without an alpha channel here.
+ */
+const VALUE_PATTERN = /^(bg|text)-\[(#[0-9A-Fa-f]{6}(?:[0-9A-Fa-f]{2})?)\]$/
+</script>
+
+<script lang="ts" setup>
+import { computed, watch } from 'vue'
+import NexxtEditorSettingsBlock from '../../atoms/EditorSettingsBlock/EditorSettingsBlock.vue'
+import NexxtColorPicker from '../../../organisms/ColorPicker/ColorPicker.vue'
+
+defineOptions({ name: 'NexxtEditorColor' })
+
+const {
+  label = 'Kleur',
+  switchable = false,
+  property = 'bg',
+  messages,
+} = defineProps<NexxtEditorColorProps>()
+
+/**
+ * The chosen colour, as the Tailwind class to apply.
+ *
+ * Beware: Tailwind only generates an arbitrary class for text it finds in the
+ * source at build time. A value that arrives at runtime -- from a database,
+ * say -- therefore gets no CSS of its own; the consumer either translates it
+ * into an inline style or safelists the classes it can produce. The hex is
+ * always parseable out of the string, which is what makes that translation
+ * possible.
+ */
+const model = defineModel<EditorColorValue>({ required: true })
+
+/** Open state of the block. Only has an effect when `switchable` is `true`. */
+const enabled = defineModel<boolean>('enabled', { default: true })
+
+const copy = computed(() => ({ ...DEFAULT_MESSAGES, ...messages }))
+
+/**
+ * The `#` is part of the model's type, so a plain `string` cannot be written
+ * into it. This narrows the picker's output and the regex capture to the shape
+ * the model promises, without a cast.
+ */
+const isHex = (value: string): value is `#${string}` => value.startsWith('#')
+
+/** The hex out of the model, or an empty string when it is not a colour class. */
+const hex = computed(() => {
+  const captured = VALUE_PATTERN.exec(model.value)?.[2]
+  return captured && isHex(captured) ? captured : ''
+})
+
+// An unparseable value -- empty, a token class such as `bg-red-500`, or copy
+// from before this component -- leaves the picker empty and its placeholder
+// visible, rather than being reported as a problem: the first pick writes a
+// valid class back.
+const picked = computed({
+  get: () => hex.value,
+  // The picker clears its own value in no flow it offers, but an empty string
+  // would still wipe a perfectly good colour, so it is dropped rather than
+  // written through. The picker keeps rendering the model's colour.
+  set: (value: string) => {
+    if (isHex(value)) model.value = `${property}-[${value}]`
+  },
+})
+
+// `property` is a prop, so the parent can flip a background setting into a
+// text-colour one while a value is already set. Rewriting the prefix here is
+// what keeps the stored class and the prop from drifting apart.
+watch(
+  () => property,
+  (next) => {
+    if (hex.value) model.value = `${next}-[${hex.value}]`
+  },
+)
+</script>
+
+<template>
+  <NexxtEditorSettingsBlock v-model="enabled" :label="label" :switchable="switchable">
+    <!--
+      The block label is a <p> (or the switch's own label), so the picker gets
+      no `label` of its own -- that would print the heading twice. Its trigger
+      falls back to the placeholder for its accessible name, which is why the
+      placeholder is the one piece of copy this component passes down.
+    -->
+    <!--
+      `matchWidth` makes the panel as wide as the full-width trigger instead of
+      the fixed `w-70` it defaults to. It works by setting a `min-width` on the
+      floating element, so a panel in a container narrower than its content
+      would still be wider than the trigger; in the settings column it is not.
+    -->
+    <NexxtColorPicker
+      v-model="picked"
+      full-width
+      match-width
+      :formats="['hex']"
+      :show-alpha="false"
+      :placeholder="copy.placeholder"
+    />
+  </NexxtEditorSettingsBlock>
+</template>

package/src/components/editor/molecules/EditorHeadingType/EditorHeadingType.vue

@@ -0,0 +1,120 @@
+<script lang="ts">
+/**
+ * The heading levels the editor offers, in the order they are listed. The level
+ * is what the option shows -- its label and its `h1`..`h6` icon -- and the size
+ * is what the model carries. The sizes are Tailwind's default scale on purpose,
+ * not the theme's `heading-*` utilities: this value is data the editor stores
+ * and puts back on an element, so it has to be a class every consumer resolves.
+ */
+const HEADING_LEVELS = [
+  { level: 1, size: 'text-4xl' },
+  { level: 2, size: 'text-3xl' },
+  { level: 3, size: 'text-2xl' },
+  { level: 4, size: 'text-xl' },
+  { level: 5, size: 'text-lg' },
+  { level: 6, size: 'text-base' },
+] as const
+
+/**
+ * The heading as the editor needs it: the Tailwind font-size class itself, so
+ * the consumer can put the model value straight on the element it styles.
+ * Weight is deliberately not part of it -- that becomes a setting of its own.
+ */
+export type EditorHeadingTypeValue = (typeof HEADING_LEVELS)[number]['size']
+
+/** Overridable copy for the six options. Every key is optional. */
+export interface EditorHeadingTypeMessages {
+  /** Label of the `h1` option. Defaults to `'Heading 1'`. */
+  h1?: string
+  /** Label of the `h2` option. Defaults to `'Heading 2'`. */
+  h2?: string
+  /** Label of the `h3` option. Defaults to `'Heading 3'`. */
+  h3?: string
+  /** Label of the `h4` option. Defaults to `'Heading 4'`. */
+  h4?: string
+  /** Label of the `h5` option. Defaults to `'Heading 5'`. */
+  h5?: string
+  /** Label of the `h6` option. Defaults to `'Heading 6'`. */
+  h6?: string
+}
+
+export interface NexxtEditorHeadingTypeProps {
+  /**
+   * Header text of the settings block. Defaults to the Dutch `'Type'`; the
+   * library has no i18n layer, so a consumer in another language passes its
+   * own copy in.
+   */
+  label?: string
+  /**
+   * Labels of the six options. The defaults use the English term "Heading",
+   * as the Dutch design in Figma does, and are merged per key, so overriding
+   * one label keeps the defaults of the others. Copy is never translated
+   * inside the component.
+   */
+  messages?: EditorHeadingTypeMessages
+}
+
+const DEFAULT_MESSAGES = {
+  h1: 'Heading 1',
+  h2: 'Heading 2',
+  h3: 'Heading 3',
+  h4: 'Heading 4',
+  h5: 'Heading 5',
+  h6: 'Heading 6',
+} satisfies Required<EditorHeadingTypeMessages>
+</script>
+
+<script lang="ts" setup>
+import { computed } from 'vue'
+import NexxtEditorSettingsBlock from '../../atoms/EditorSettingsBlock/EditorSettingsBlock.vue'
+import NexxtSelect from '../../../molecules/Select/Select.vue'
+import type { SelectOption } from '../../../molecules/Select/Select.vue'
+
+defineOptions({ name: 'NexxtEditorHeadingType' })
+
+const { label = 'Type', messages } = defineProps<NexxtEditorHeadingTypeProps>()
+
+/** The selected heading, as the Tailwind font-size class to apply. */
+const model = defineModel<EditorHeadingTypeValue>({ required: true })
+
+const copy = computed(() => ({ ...DEFAULT_MESSAGES, ...messages }))
+
+// The level doubles as the messages key and the Font Awesome icon name --
+// `h1` through `h6` all exist in the kit.
+const options = computed<SelectOption[]>(() =>
+  HEADING_LEVELS.map(({ level, size }) => {
+    const key = `h${level}` as const
+    return { value: size, label: copy.value[key], icon: key }
+  }),
+)
+
+const values = HEADING_LEVELS.map(({ size }) => size)
+
+// Select types its model as the open `string | number | null` of its options,
+// so writing straight back into the narrower model is a type error. The setter
+// is the one place that narrowing happens, and it is guarded: a value that is
+// not one of the six options is dropped rather than written through.
+const selected = computed({
+  get: () => model.value,
+  set: (value: string | number | null) => {
+    const found = values.find((option) => option === value)
+    if (found) model.value = found
+  },
+})
+</script>
+
+<template>
+  <NexxtEditorSettingsBlock :label="label">
+    <!--
+      Select is `inline-flex` and its field carries a `min-w-60`, so without
+      `w-full` it would sit at that minimum instead of filling the block. The
+      class lands on Select's root, whose trigger is already `w-full`.
+    -->
+    <!--
+      The block label is a <p>, not a <label>, so the combobox would have no
+      accessible name of its own; `aria-label` gives it the same copy without
+      repeating it on screen.
+    -->
+    <NexxtSelect v-model="selected" :options="options" :aria-label="label" class="w-full" />
+  </NexxtEditorSettingsBlock>
+</template>

package/src/components/molecules/Select/Select.vue

@@ -3,11 +3,25 @@ import { computed, ref, useTemplateRef, watch } from 'vue'
 import NexxtIcon from '../../atoms/Icon/Icon.vue'
 import NexxtFloatingPanel from '../../atoms/FloatingPanel/FloatingPanel.vue'
 import type Icon from '../../atoms/Icon/Icon.vue'
-
-export type SelectOption = { label: string; value: string | number } | string
+import type { NexxtIconName } from '../../atoms/Icon/Icon.vue'
+
+export type SelectOption =
+  | {
+      label: string
+      value: string | number
+      /**
+       * Icon rendered before the option's label in the list, and in the field
+       * while the option is selected. Optional; an explicit `leftIcon` on the
+       * field wins over it.
+       */
+      icon?: NexxtIconName
+    }
+  | string
 
 const getLabel = (opt: SelectOption) => (typeof opt === 'string' ? opt : opt.label)
 const getValue = (opt: SelectOption): string | number => (typeof opt === 'string' ? opt : opt.value)
+const getIcon = (opt: SelectOption): NexxtIconName | undefined =>
+  typeof opt === 'string' ? undefined : opt.icon
 
 const generateId = () => 'select-' + Math.random().toString(36).slice(2, 10)
 const selectId = generateId()
@@ -31,6 +45,13 @@ interface NexxtSelectProps {
   leftIcon?: InstanceType<typeof Icon>['name']
   /** Mark the field as required (renders an asterisk next to the label). */
   required?: boolean
+  /**
+   * Accessible name of the field, for when it is labelled by something outside
+   * the component and `label` would duplicate that copy on screen. Lands on the
+   * combobox itself, which a fallthrough attribute cannot reach: the component
+   * root is the wrapper around it.
+   */
+  ariaLabel?: string
 }
 
 const props = withDefaults(defineProps<NexxtSelectProps>(), {
@@ -55,6 +76,14 @@ const selectedIndex = computed(() =>
   props.options.findIndex((opt) => getValue(opt) === model.value),
 )
 
+// The field shows one icon at most. An explicit `leftIcon` is the field's own
+// decoration and outranks the selected option's icon, which is only a fallback.
+const triggerIcon = computed<NexxtIconName | undefined>(() => {
+  if (props.leftIcon) return props.leftIcon
+  const found = props.options.find((opt) => getValue(opt) === model.value)
+  return found ? getIcon(found) : undefined
+})
+
 const select = (opt: SelectOption, close: () => void) => {
   model.value = getValue(opt)
   close()
@@ -139,22 +168,26 @@ watch(model, () => {
         <div
           :id="selectId"
           role="combobox"
+          :aria-label="ariaLabel"
           :aria-expanded="isOpen"
           aria-haspopup="listbox"
           :aria-controls="isOpen ? listboxId : undefined"
           :aria-activedescendant="isOpen && activeIndex >= 0 ? optionId(activeIndex) : undefined"
           tabindex="0"
           class="group flex w-full cursor-pointer items-center gap-2 rounded-lg ring transition-colors ease-out focus:ring-cornflower-blue-500 focus:outline-none"
-          :class="[error ? 'ring-brick-400' : 'ring-gray-200', { 'pl-3': leftIcon, 'pr-3': true }]"
+          :class="[
+            error ? 'ring-brick-400' : 'ring-gray-200',
+            { 'pl-3': triggerIcon, 'pr-3': true },
+          ]"
           @click="toggle"
           @keydown="onKeydown"
         >
-          <span v-if="leftIcon" class="flex items-center">
-            <NexxtIcon :name="leftIcon" />
+          <span v-if="triggerIcon" class="flex items-center">
+            <NexxtIcon :name="triggerIcon" />
           </span>
           <span
             class="flex h-10 w-full min-w-60 items-center text-sm"
-            :class="[selectedLabel ? 'text-gray-900' : 'text-gray-400', { 'pl-3': !leftIcon }]"
+            :class="[selectedLabel ? 'text-gray-900' : 'text-gray-400', { 'pl-3': !triggerIcon }]"
           >
             {{ selectedLabel ?? placeholder }}
           </span>
@@ -186,7 +219,16 @@ watch(model, () => {
             @click="select(opt, close)"
             @mousemove="activeIndex = index"
           >
-            {{ getLabel(opt) }}
+            <span class="flex items-center gap-2">
+              <!-- The cast is the v-if guard restated: `name` is required, and
+                   template narrowing does not carry across a function call. -->
+              <NexxtIcon
+                v-if="getIcon(opt)"
+                :name="getIcon(opt) as NexxtIconName"
+                class="shrink-0"
+              />
+              {{ getLabel(opt) }}
+            </span>
             <NexxtIcon v-if="model === getValue(opt)" name="check" class="text-xs" />
           </li>
         </ul>

package/src/components.json

@@ -63,9 +63,11 @@
   "NexxtVideoPlayer": "components/organisms/VideoPlayer/VideoPlayer.vue",
   "NexxtEditorSettingsBlock": "components/editor/atoms/EditorSettingsBlock/EditorSettingsBlock.vue",
   "NexxtEditorAlignItems": "components/editor/molecules/EditorAlignItems/EditorAlignItems.vue",
+  "NexxtEditorColor": "components/editor/molecules/EditorColor/EditorColor.vue",
   "NexxtEditorFlexDirection": "components/editor/molecules/EditorFlexDirection/EditorFlexDirection.vue",
   "NexxtEditorGap": "components/editor/molecules/EditorGap/EditorGap.vue",
+  "NexxtEditorHeadingType": "components/editor/molecules/EditorHeadingType/EditorHeadingType.vue",
   "NexxtEditorJustifyContent": "components/editor/molecules/EditorJustifyContent/EditorJustifyContent.vue",
-  "NexxtEditorRadius": "components/editor/molecules/EditorRadius/EditorRadius.vue",
-  "NexxtEditorPadding": "components/editor/molecules/EditorPadding/EditorPadding.vue"
+  "NexxtEditorPadding": "components/editor/molecules/EditorPadding/EditorPadding.vue",
+  "NexxtEditorRadius": "components/editor/molecules/EditorRadius/EditorRadius.vue"
 }

package/src/index.ts

@@ -25,6 +25,15 @@ export type {
   EditorGapMessages,
   EditorGapValue,
 } from './components/editor/molecules/EditorGap/EditorGap.vue'
+export type {
+  EditorColorMessages,
+  EditorColorProperty,
+  EditorColorValue,
+} from './components/editor/molecules/EditorColor/EditorColor.vue'
+export type {
+  EditorHeadingTypeMessages,
+  EditorHeadingTypeValue,
+} from './components/editor/molecules/EditorHeadingType/EditorHeadingType.vue'
 export type {
   EditorRadiusMessages,
   EditorRadiusValue,
@@ -58,11 +67,13 @@ export { default as NexxtDatePicker } from './components/organisms/DatePicker/Da
 export { default as NexxtDoughnutChart } from './components/molecules/DoughnutChart/DoughnutChart.vue'
 export { default as NexxtDropdownButton } from './components/organisms/DropdownButton/DropdownButton.vue'
 export { default as NexxtEditorAlignItems } from './components/editor/molecules/EditorAlignItems/EditorAlignItems.vue'
+export { default as NexxtEditorColor } from './components/editor/molecules/EditorColor/EditorColor.vue'
 export { default as NexxtEditorFlexDirection } from './components/editor/molecules/EditorFlexDirection/EditorFlexDirection.vue'
 export { default as NexxtEditorGap } from './components/editor/molecules/EditorGap/EditorGap.vue'
+export { default as NexxtEditorHeadingType } from './components/editor/molecules/EditorHeadingType/EditorHeadingType.vue'
 export { default as NexxtEditorJustifyContent } from './components/editor/molecules/EditorJustifyContent/EditorJustifyContent.vue'
-export { default as NexxtEditorRadius } from './components/editor/molecules/EditorRadius/EditorRadius.vue'
 export { default as NexxtEditorPadding } from './components/editor/molecules/EditorPadding/EditorPadding.vue'
+export { default as NexxtEditorRadius } from './components/editor/molecules/EditorRadius/EditorRadius.vue'
 export { default as NexxtEditorSettingsBlock } from './components/editor/atoms/EditorSettingsBlock/EditorSettingsBlock.vue'
 export { default as NexxtEnergyLabel } from './components/atoms/EnergyLabel/EnergyLabel.vue'
 export { default as NexxtFloatingPanel } from './components/atoms/FloatingPanel/FloatingPanel.vue'