wave-ui 2.47.0 → 3.0.0

package/src/wave-ui/scss/_variables.scss

@@ -1,10 +1,40 @@
 @use "sass:math";
+@use "sass:map";
 
 @function divide($a, $b) {
   @return math.div($a, $b); // Must use `sass` & not `node-sass`.
-  // @return $a / $b;
 }
 
+// THEME COLORS.
+// ========================================================
+// These colors are defined by a list of RBG channels only, so you can later apply any alpha channel.
+// If you don't need themes, you can leave this as is and override the global defaults.
+$theme-light: (
+  base-bg-color-rgb: (255, 255, 255), // #fff.
+  base-color-rgb: (0, 0, 0), // #000.
+  contrast-bg-color-rgb: (0, 0, 0), // #000.
+  contrast-color-rgb: (255, 255, 255), // #fff.
+  disabled-color-rgb: (204, 204, 204), // #ccc.
+) !default;
+
+$theme-dark: (
+  base-bg-color-rgb: (34, 34, 34), // #222.
+  base-color-rgb: (255, 255, 255), // #fff.
+  contrast-bg-color-rgb: (255, 255, 255), // #fff.
+  contrast-color-rgb: (0, 0, 0), // #000.
+  disabled-color-rgb: (74, 74, 74), // #4a4a4a.
+) !default;
+
+// These variables are filled up with the current theme colors for you to use.
+$primary: var(--w-primary-color);
+$secondary: var(--w-secondary-color);
+$base-bg-color: rgb(var(--w-base-bg-color-rgb));
+$base-color: rgb(var(--w-base-color-rgb));
+$contrast-bg-color: rgb(var(--w-contrast-bg-color-rgb));
+$contrast-color: rgb(var(--w-contrast-color-rgb));
+// When a form element is disabled (checkbox, radio, input, select list).
+$disabled-color: rgb(var(--w-disabled-color-rgb));
+
 // GLOBAL DEFAULTS.
 // ========================================================
 $css-scope: '.w-app' !default; // Allows control on CSS rules priority.
@@ -15,47 +45,106 @@ $base-font-size: 14px !default; // Must be a px unit.
 $base-increment: round(divide($base-font-size, 4)) !default;
 $layout-padding: $base-increment * 4 !default; // Applied on the .content-wrap tag.
 $border-radius: 3px !default;
-$border-color: rgba(0, 0, 0, 0.15);
+$border-color: rgba(var(--w-contrast-bg-color-rgb), 0.15) !default;
 $border: 1px solid $border-color !default;
 $transition-duration: 0.25s !default;
 $fast-transition-duration: 0.15s !default;
 $box-shadow: 0 3px 1px -2px rgba(0, 0, 0, 0.2),
              0 2px 2px 0 rgba(0, 0, 0, 0.15),
              0 1px 5px 0 rgba(0, 0, 0, 0.15) !default;
-// When a form element is disabled (checkbox, radio, input, select list).
-$disabled-color: #ccc;
 $form-field-height: round(2 * $base-font-size) !default;
 // Always an even number for better vertical alignment. (Used in checkbox, radio, switch)
 $small-form-el-size: round(divide(1.3 * $base-font-size, 2)) * 2 !default;
 
+// Detachable elements are: w-tooltip, w-menu, w-confirm.
+$detachable-bg-color: $base-bg-color !default;
+$detachable-color: $base-color !default;
+
 // COMPONENTS DEFAULTS.
 // ========================================================
+// w-confirm.
+// --------------------------------------------------------
+$confirm-bg-color: $detachable-bg-color !default;
+$confirm-color: $detachable-color !default;
+// --------------------------------------------------------
+
+// w-dialog.
+// --------------------------------------------------------
+$dialog-bg-color: $base-bg-color !default;
+// --------------------------------------------------------
+
+// w-divider.
+// --------------------------------------------------------
+$divider-color: $border-color !default;
+// --------------------------------------------------------
+
 // w-drawer.
+// --------------------------------------------------------
 $drawer-max-size: 380px !default;
+$drawer-bg-color: $base-bg-color !default;
+// --------------------------------------------------------
+
+// w-menu.
+// --------------------------------------------------------
+$menu-bg-color: $detachable-bg-color !default;
+$menu-color: $detachable-color !default;
+// --------------------------------------------------------
+
+// w-progress.
+// --------------------------------------------------------
+$progress-bg-color: rgba(var(--w-contrast-bg-color-rgb), 0.15) !default;
+// --------------------------------------------------------
+
+// w-rating.
+// --------------------------------------------------------
+$rating-bg-color: rgba(var(--w-contrast-bg-color-rgb), 0.25) !default;
 // --------------------------------------------------------
 
 // w-slider.
 // --------------------------------------------------------
 $slider-height: $base-increment !default;
-$slider-track-color: #ddd;
+$slider-track-color: rgba(var(--w-contrast-bg-color-rgb), 0.15) !default;
+$slider-thumb-button-bg-color: $base-bg-color !default;
+$slider-thumb-label-bg-color: $base-bg-color !default;
+$slider-thumb-label-color: rgba(var(--w-base-color-rgb), 0.75) !default;
+$slider-step-label-bg-color: rgba(var(--w-contrast-bg-color-rgb), 0.2) !default;
+$slider-step-label-color: rgba(var(--w-base-color-rgb), 0.5) !default;
+
+// w-switch.
+// --------------------------------------------------------
+$switch-inactive-color: rgba(var(--w-contrast-bg-color-rgb), 0.25) !default;
+$switch-thumb-color: #fff !default;
 // --------------------------------------------------------
 
 // w-table.
 // --------------------------------------------------------
-$table-tr-odd-color: rgba(0, 0, 0, 0.02);
-$table-tr-hover-color: rgba(0, 0, 0, 0.05);
-$table-color: rgba(0, 0, 0, 0.7);
+$table-tr-odd-color: rgba(0, 0, 0, 0.02) !default;
+$table-tr-hover-color: rgba(0, 0, 0, 0.05) !default;
+$table-color: rgba(var(--w-contrast-color-rgb), 0.7) !default;
 // --------------------------------------------------------
 
 // w-textarea.
 // --------------------------------------------------------
-$textarea-line-height: 1.2;
+$textarea-line-height: 1.2 !default;
+// --------------------------------------------------------
+
+// w-timeline.
+// --------------------------------------------------------
+$timeline-bullet-color: $base-bg-color !default;
+$timeline-bg-color: rgba(var(--w-contrast-bg-color-rgb), 0.25) !default;
+// --------------------------------------------------------
+
+// w-toolbar.
+// --------------------------------------------------------
+$toolbar-max-size: 380px !default;
+$toolbar-bg-color: $base-bg-color !default;
 // --------------------------------------------------------
 
 // w-tooltip.
 // --------------------------------------------------------
-$tooltip-bg-color: #fff;
-$tooltip-color: rgba(0, 0, 0, 0.7);
+$tooltip-bg-color: $detachable-bg-color !default;
+$tooltip-color: $detachable-color !default;
+$tooltip-border-color: $border-color !default;
 // --------------------------------------------------------
 
 // Mixins.

package/src/wave-ui/utils/colors.js

@@ -1,4 +1,58 @@
-export default [
+const shadeColor = (color, amount) => {
+  return '#' + color.slice(1).match(/../g)
+    .map(x => {
+      x = +`0x${x}` + amount
+      return (x < 0 ? 0 : (x > 255 ? 255 : x)).toString(16).padStart(2, 0)
+    })
+    .join('')
+}
+
+/**
+ * Generates the color shades for each custom color and status colors for the current theme (only),
+ * and save it in the config object.
+ *
+ * @param {Object} config
+ */
+export const generateColorShades = config => {
+  // Add color shades for each custom color and status color of each theme.
+  ['light', 'dark'].forEach(theme => {
+    const themeOfColors = config.colors[theme]
+    themeOfColors.shades = {}
+
+    for (let color in themeOfColors) {
+      if (color === 'shades') continue // Skip if item is the `shades` container.
+      color = { label: color, color: themeOfColors[color].replace('#', '') }
+      const col = color.color
+      if (col.length === 3) color.color = col[0] + '' + col[0] + col[1] + col[1] + col[2] + col[2]
+
+      for (let i = 1; i <= 3; i++) {
+        const lighterColor = shadeColor(`#${color.color}`, i * 40)
+        const darkerColor = shadeColor(`#${color.color}`, -i * 40)
+        // Adding the shades to the config object to generate the CSS from w-app.
+        themeOfColors.shades[`${color.label}-light${i}`] = lighterColor
+        themeOfColors.shades[`${color.label}-dark${i}`] = darkerColor
+      }
+    }
+  })
+}
+
+export const flattenColors = (themeColors, colorPalette) => {
+  const colors = {
+    ...colorPalette.reduce((obj, color) => {
+      obj[color.label] = color.color
+      const shades = (color.shades || []).reduce((obj, color) => {
+        obj[color.label] = color.color
+        return obj
+      }, {})
+      return { ...obj, ...shades }
+    }, { ...themeColors, ...themeColors.shades })
+  }
+  delete colors.shades
+
+  return colors
+}
+
+export const colorPalette = [
   {
     label: 'pink',
     color: '#e91e63',
@@ -15,7 +69,6 @@ export default [
       { label: 'pink-dark4', color: '#7c0c32' },
       { label: 'pink-dark5', color: '#600927' },
       { label: 'pink-dark6', color: '#43071b' }
-
     ]
   },
   {
@@ -342,5 +395,9 @@ export default [
       { label: 'grey-dark5', color: '#353535' },
       { label: 'grey-dark6', color: '#252525' }
     ]
-  }
+  },
+  { label: 'black', color: '#000' },
+  { label: 'white', color: '#fff' },
+  { label: 'transparent', color: 'transparent' },
+  { label: 'inherit', color: 'inherit' }
 ]

package/src/wave-ui/utils/config.js

@@ -1,6 +1,7 @@
 import { reactive } from 'vue'
 
 const config = reactive({
+  on: '#app', // Sets the Wave UI root node. If not found, will default to `body`.
   breakpoints: {
     xs: 600,
     sm: 900,
@@ -10,7 +11,7 @@ const config = reactive({
   },
   css: {
     // Generate shades for custom colors and status colors.
-    // Palette color shades are always generated with palette.
+    // Note: the color palette shades are always generated separately from SCSS.
     colorShades: true,
 
     // Generate palette colors and palette color shades.
@@ -24,13 +25,27 @@ const config = reactive({
     grid: 12
   },
   colors: {
-    primary: '#234781',
-    secondary: '#d3ebff',
-    success: '#54b946',
-    error: '#f65555',
-    warning: '#f80',
-    info: '#3d9ff5'
+    // Default colors of Wave UI. Can be overridden from the Wave UI user config on init.
+    light: {
+      primary: '#234781',
+      secondary: '#d3ebff',
+      info: '#3d9ff5',
+      warning: '#f80',
+      success: '#54b946',
+      error: '#f65555'
+    },
+    dark: {
+      primary: '#89b6d2',
+      secondary: '#375b6a',
+      info: '#3d9ff5',
+      warning: '#f80',
+      success: '#54b946',
+      error: '#f65555'
+    }
   },
+  // The initial theme to use.
+  // To switch theme while running, call the $waveui.switchTheme('light'|'dark') method.
+  theme: 'light', // One of 'light', 'dark', 'auto'.
   icons: [],
   iconsLigature: false,
   notificationManager: {
@@ -43,9 +58,18 @@ const config = reactive({
 export { config as default }
 
 export const mergeConfig = (options, conf = config) => {
-  for (const key in options) {
-    const option = options[key]
-    if (typeof option === 'object') mergeConfig(options[key], conf[key])
-    else conf[key] = option
+  // If the conf object is empty, populate with options (case of presets).
+  if (!Object.keys(conf).length) conf = Object.assign(conf, options)
+
+  else {
+    for (const key in options) {
+      const option = options[key]
+      if (typeof option === 'object') {
+        mergeConfig(options[key], conf[key])
+      }
+      else conf[key] = option
+    }
   }
+
+  return conf
 }

package/src/wave-ui/utils/dynamic-css.js

@@ -5,43 +5,49 @@ const cssVars = {
   baseIncrement: 4
 }
 
-const generateColors = config => {
+// Global var for faster results in the resize event handler.
+let breakpointsDef = { keys: [], values: [] }
+let currentBreakpoint = null
+
+// Generates the CSS for all the dynamic colors and shades. E.g.
+// :root {[color1-variable], [color2-variable]}
+// .color1--bg {background-color: [color1-variable]}
+// .color1 {color: [color1-variable]}
+const generateColors = themeColors => {
   let styles = ''
-  const { cssScope } = cssVars
+  const cssVariables = {}
 
   // Extract status colors and place them after the other colors.
-  const { info, warning, success, error, ...colors } = config.colors
+  const { info, warning, success, error, shades, ...colors } = themeColors
+  const { cssScope } = cssVars
 
-  for (const color in colors) {
+  // User custom colors.
+  // ------------------------------------------------------
+  for (const colorName in colors) {
     styles +=
-      `${cssScope} .${color}--bg{background-color:${config.colors[color]}}` +
-      `${cssScope} .${color}{color:${config.colors[color]}}`
+      `${cssScope} .${colorName}--bg{background-color:var(--w-${colorName}-color)}` +
+      `${cssScope} .${colorName}{color:var(--w-${colorName}-color)}`
   }
-
-  // Color shades are generated in core.js, if the option is on.
-  if (config.css.colorShades && config.colorShades) {
-    Object.entries(config.colorShades).forEach(([label, color]) => {
-      styles +=
-        `${cssScope} .${label}--bg{background-color:${color}}` +
-        `${cssScope} .${label}{color:${color}}`
-    })
+  // The shades don't need css vars.
+  for (const colorName in shades) {
+    styles +=
+      `${cssScope} .${colorName}--bg{background-color:${shades[colorName]}}` +
+      `${cssScope} .${colorName}{color:${shades[colorName]}}`
   }
 
+  // Creating CSS3 variables.
+  // ------------------------------------------------------
+  // Create a CSS variable for each color for theming and reuse in components.
   // Status colors must remain after the other colors so they have priority in form validations.
   // That only makes sense when there are 2 colors on the same element: e.g. `span.primary.error`.
-  const statusColors = { info, warning, success, error } // This order is also important for priorities.
-  for (const color in statusColors) {
-    styles +=
-      `${cssScope} .${color}--bg{background-color:${config.colors[color]}}` +
-      `${cssScope} .${color}{color:${config.colors[color]}}`
-  }
-
-  // Add the primary color to the CSS variables for reuse in components.
-  const cssVariables = []
-  cssVariables.push(`--primary: ${config.colors.primary}`)
-  styles += `:root {${cssVariables.join(';')}}`
+  const allColors = { ...colors, info, warning, success, error }
+  for (const colorName in allColors) cssVariables[colorName] = allColors[colorName]
+  let cssVariablesString = ''
+  Object.entries(cssVariables).forEach(([colorName, colorHex]) => {
+    cssVariablesString += `--w-${colorName}-color: ${colorHex};`
+  })
 
-  return styles
+  return `:root{${cssVariablesString}}${styles}`
 }
 
 // Generate the layout grid. E.g. xs1, xs2, ..., xl12.
@@ -218,7 +224,64 @@ const genBreakpointLayoutClasses = breakpoints => {
   return styles
 }
 
-export default config => {
+const getBreakpoint = $waveui => {
+  const width = window.innerWidth
+  const breakpoints = breakpointsDef.values.slice(0)
+  // Most performant lookup.
+  breakpoints.push(width)
+  breakpoints.sort((a, b) => a - b)
+  const breakpoint = breakpointsDef.keys[breakpoints.indexOf(width)] || 'xl'
+
+  if (breakpoint !== currentBreakpoint) {
+    currentBreakpoint = breakpoint
+    $waveui.breakpoint = {
+      name: breakpoint,
+      xs: breakpoint === 'xs',
+      sm: breakpoint === 'sm',
+      md: breakpoint === 'md',
+      lg: breakpoint === 'lg',
+      xl: breakpoint === 'xl',
+      width
+    }
+  }
+
+  $waveui.breakpoint.width = window.innerWidth
+}
+
+// Should run on first mounted hook.
+export const injectCSSInDOM = $waveui => {
+  const { config } = $waveui
+  breakpointsDef = { keys: Object.keys(config.breakpoints), values: Object.values(config.breakpoints) }
+
+  // Inject global dynamic CSS classes in document head.
+  if (!document.getElementById('wave-ui-styles')) {
+    const css = document.createElement('style')
+    css.id = 'wave-ui-styles'
+    css.innerHTML = doDynamicCSS(config)
+
+    const firstStyle = document.head.querySelectorAll('style,link[rel="stylesheet"]')[0]
+    if (firstStyle) firstStyle.before(css)
+    else document.head.appendChild(css)
+  }
+
+  getBreakpoint($waveui)
+  window.addEventListener('resize', () => getBreakpoint($waveui))
+}
+
+export const injectColorsCSSInDOM = themeColors => {
+  // Inject global dynamic CSS classes in document head.
+  if (!document.getElementById('wave-ui-colors')) {
+    const css = document.createElement('style')
+    css.id = 'wave-ui-colors'
+    css.innerHTML = generateColors(themeColors)
+
+    const firstStyle = document.head.querySelectorAll('style,link[rel="stylesheet"]')[0]
+    if (firstStyle) firstStyle.before(css)
+    else document.head.appendChild(css)
+  }
+}
+
+const doDynamicCSS = config => {
   const entries = Object.entries(config.breakpoints)
   const breakpointsDef = entries.map(([label, max], i) => {
     // Construct the breakpoint objects.
@@ -227,11 +290,10 @@ export default config => {
   })
 
   const computedStyles = getComputedStyle(document.documentElement)
-  cssVars.cssScope = computedStyles.getPropertyValue('--css-scope')
-  cssVars.baseIncrement = parseInt(computedStyles.getPropertyValue('--base-increment'))
+  cssVars.cssScope = computedStyles.getPropertyValue('--w-css-scope')
+  cssVars.baseIncrement = parseInt(computedStyles.getPropertyValue('--w-base-increment'))
 
   let styles = ''
-  styles += generateColors(config)
   styles += generateBreakpoints(breakpointsDef, config.css.grid)
   if (config.css.breakpointLayoutClasses) styles += genBreakpointLayoutClasses(breakpointsDef)
   // if (config.css.breakpointSpaces) styles += generateBreakpointSpaces(breakpointsDef)

package/src/wave-ui/utils/notification-manager.js

@@ -1,9 +1,8 @@
-// @todo: find a way to use private fields with Vue 3 proxies.
-// https://github.com/tc39/proposal-class-fields/issues/106
-// https://github.com/tc39/proposal-class-fields/issues/227
+import { createApp, defineComponent } from 'vue'
+import WNotificationManager from '../components/w-notification-manager.vue'
 
-export default class NotificationManager {
-  static instance
+export class NotificationManager {
+  static #instance
   notifications
    // Private fields.
   _uid // A unique ID for each notification.
@@ -11,9 +10,8 @@ export default class NotificationManager {
 
   constructor () {
     // Singleton pattern.
-    if (NotificationManager.instance) return NotificationManager.instance
+    if (NotificationManager.#instance) return NotificationManager.#instance
 
-    NotificationManager.instance = this
     this.notifications = []
     this._uid = 0
     this._notificationDefaults = {
@@ -23,10 +21,14 @@ export default class NotificationManager {
       timeout: 4000,
       dismiss: true
     }
+    NotificationManager.#instance = this
   }
 
   notify (...args) {
-    let notification = { ...this._notificationDefaults, _uid: this._uid++ }
+    let notification = {
+      ...this._notificationDefaults,
+      _uid: this._uid++
+    }
 
     if (typeof args[0] === 'object') notification = { ...notification, ...args[0] }
     else {
@@ -38,6 +40,10 @@ export default class NotificationManager {
         timeout: timeout || timeout === 0 ? parseFloat(timeout) : 4000
       }
     }
+
+    // Allow calling notification.dismiss().
+    if (notification.dismiss) notification.dismiss = () => this.dismiss(notification._uid)
+
     this.notifications.push(notification)
     if (~~notification.timeout !== 0) setTimeout(() => this.dismiss(notification._uid), notification.timeout)
   }
@@ -46,3 +52,28 @@ export default class NotificationManager {
     this.notifications = this.notifications.filter(item => item._uid !== uid)
   }
 }
+
+/**
+ * Injects the w-notification-manager in the DOM programmatically so the user does not have to do it.
+ *
+ * @param {Object} wApp The DOM element where to mount the w-notification-manager.
+ * @param {Object} components All the Wave UI components to provide to the w-notification-manager,
+ *                            so it can also use them.
+ * @param {Object} $waveui the injected reactive instance of the WaveUI class.
+ */
+export const injectNotifManagerInDOM = (wApp, components, $waveui) => {
+  const div = document.createElement('div')
+  wApp.appendChild(div)
+
+  const WNotifManager = createApp(defineComponent({
+    ...WNotificationManager,
+    inject: ['$waveui']
+  })).provide('$waveui', $waveui)
+
+  for (const id in components) {
+    const component = components[id]
+    WNotifManager.component(component.name, { ...component, inject: ['$waveui'] })
+  }
+  WNotifManager.mount(div)
+  div.remove() // The WNotificationManager contains a teleport to .w-app.
+}