wave-ui 1.61.0 → 1.63.0

package/src/wave-ui/core.js

@@ -1,40 +1,45 @@
-import config, { mergeConfig } from './utils/config'
+import { mergeConfig } from './utils/config'
 import NotificationManager from './utils/notification-manager'
-import colors from './utils/colors'
+import { colorPalette, generateColorShades, flattenColors } from './utils/colors'
 // import * as directives from './directives'
 
-const shadeColor = (color, amount) => {
-  return '#' + color.slice(1).match(/../g)
-    .map(x => (x =+ `0x${x}` + amount, x < 0 ? 0 : ( x > 255 ? 255 : x)).toString(16).padStart(2, 0))
-    .join('')
+/**
+ * Inject presets into a Vue component props defaults before its registration into the app.
+ *
+ * @param {Object} component the Vue component to inject presets into.
+ * @param {Object} presets the presets to inject. E.g. `{ bgColor: 'green' }`.
+ */
+const injectPresets = (component, presets) => {
+  for (const preset in presets) {
+    component.props[preset].default = presets[preset]
+  }
 }
 
 export default class WaveUI {
   static instance = null
   static vueInstance = null // Needed until constructor is called.
-  #notificationManager
 
-  // Public breakpoint object. Accessible from this.$waveui.breakpoint.
-  breakpoint = {
-    name: '',
-    xs: false,
-    sm: false,
-    md: false,
-    lg: false,
-    xl: false
+  // Exposed as a global object and also `app.provide`d.
+  // Accessible from this.$waveui, or inject('$waveui').
+  $waveui = {
+    breakpoint: {
+      name: '',
+      xs: false,
+      sm: false,
+      md: false,
+      lg: false,
+      xl: false
+    },
+    config: {},
+    colors: {}, // Object of pairs of color-name => color hex.
+    _notificationManager: null,
+
+    // Callable from this.$waveui.
+    notify (...args) {
+      this._notificationManager.notify(...args)
+    }
   }
 
-  // A public object containing pairs of color-name => color hex.
-  // Accessible from anywhere via `this.$waveui.colors`.
-  // These colors generate the CSS in `w-app` on mounted.
-  colors = colors.reduce((obj, color) => {
-    obj[color.label] = color.color
-    color.shades.forEach(shade => (obj[shade.label] = shade.color))
-    return obj
-  }, { ...config.colors, black: '#000', white: '#fff', transparent: 'transparent', inherit: 'inherit' })
-
-  config = {} // Store and expose the config in the $waveui object.
-
   static install (Vue, options = {}) {
     // Register directives.
     // for (const id in directives) {
@@ -57,6 +62,8 @@ export default class WaveUI {
     const { components = {} } = options || {}
     for (let id in components) {
       const component = components[id]
+      // If presets are defined for this component inject them into the props defaults.
+      if (options.presets?.[component.name]) injectPresets(component, options.presets[component.name])
       Vue.component(component.name, component)
     }
 
@@ -74,53 +81,22 @@ export default class WaveUI {
   constructor (options = {}) {
     if (WaveUI.instance) return WaveUI.instance
 
-    else {
-      this.#notificationManager = new NotificationManager()
-
-      // Merge user options into the default config.
-      mergeConfig(options)
-
-      // Add color shades for each custom color given in options.
-      if (config.css.colorShades) {
-        config.colorShades = {}
-
-        for (let color in config.colors) {
-          color = { label: color, color: config.colors[color].replace('#', '') }
-          const col = color.color
-          if (col.length === 3) color.color = col[0] + '' + col[0] + col[1] + col[1] + col[2] + col[2]
+    this.$waveui._notificationManager = new NotificationManager()
 
-          this.colors[color.label] = `#${color.color}`
+    // Merge user options into the default config.
+    this.$waveui.config = mergeConfig(options)
+    const config = this.$waveui.config
 
-          for (let i = 1; i <= 3; i++) {
-            const lighterColor = shadeColor(`#${color.color}`, i * 40)
-            const darkerColor = shadeColor(`#${color.color}`, -i * 40)
-            this.colors[`${color.label}-light${i}`] = lighterColor
-            this.colors[`${color.label}-dark${i}`] = darkerColor
+    // Generates color shades for each color of each theme and store in the config.colors object.
+    if (config.css.colorShades) generateColorShades(config)
+    this.$waveui.colors = flattenColors(config.colors, colorPalette)
 
-            // Adding the shades to the config object to generate the CSS from w-app.
-            config.colorShades[`${color.label}-light${i}`] = lighterColor
-            config.colorShades[`${color.label}-dark${i}`] = darkerColor
-          }
-        }
-      }
-
-      this.config = config
-      this.notify = (...args) => notificationManager.notify(...args)
-      WaveUI.instance = this
+    WaveUI.instance = this
 
-      // Make waveui reactive and expose the single instance in Vue.
-      WaveUI.vueInstance.prototype.$waveui = WaveUI.vueInstance.observable(this)
+    // Make Wave UI reactive and expose the single instance in the app.
+    const $waveui = WaveUI.vueInstance.observable(this.$waveui)
+    WaveUI.vueInstance.prototype.$waveui = $waveui
 
-      delete WaveUI.vueInstance // Get rid of the Vue instance that we don't need anymore.
-    }
-  }
-
-  notify (...args) {
-    this.#notificationManager.notify(...args)
+    delete WaveUI.vueInstance // Get rid of the Vue instance that we don't need anymore.
   }
 }
-
-/**
- * Returns the WaveUI instance. Equivalent to using `$waveui` inside templates.
- */
-export const useWaveUI = () => inject('$waveui')

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

@@ -170,7 +170,7 @@
 
     // Sizes.
     // ----------------------------------------------
-    // In all the sizes bellow, round(x / 2) * 2 to always have even numbers.
+    // In all the sizes below, round(x / 2) * 2 to always have even numbers.
     // Different heights with a mix of odd and even numbers will misalign
     // when vertically centering (vertical-align or align-items center).
     .size--xs {font-size: round(0.85 * $base-font-size);}

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

@@ -1,4 +1,54 @@
-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 => {
+  config.shades = {}
+
+  for (let color in config.colors) {
+    color = { label: color, color: config.colors[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.
+      config.shades[`${color.label}-light${i}`] = lighterColor
+      config.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',
@@ -342,5 +392,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

@@ -11,7 +11,7 @@ const config = Vue.observable({
   },
   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.
@@ -27,10 +27,10 @@ const config = Vue.observable({
   colors: {
     primary: '#234781',
     secondary: '#d3ebff',
-    success: '#54b946',
-    error: '#f65555',
+    info: '#3d9ff5',
     warning: '#f80',
-    info: '#3d9ff5'
+    success: '#54b946',
+    error: '#f65555'
   },
   icons: [],
   iconsLigature: false,
@@ -44,9 +44,18 @@ const config = Vue.observable({
 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

@@ -19,8 +19,8 @@ const generateColors = config => {
   }
 
   // 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]) => {
+  if (config.css.colorShades && config.shades) {
+    Object.entries(config.shades).forEach(([label, color]) => {
       styles +=
         `${cssScope} .${label}--bg{background-color:${color}}` +
         `${cssScope} .${label}{color:${color}}`

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

@@ -1,7 +1,7 @@
 import Vue from 'vue'
 
 export default class NotificationManager {
-  static instance
+  static #instance
   notifications
   // Private fields.
   #uid // A unique ID for each notification.
@@ -9,9 +9,9 @@ export default class NotificationManager {
 
   constructor () {
     // Singleton pattern.
-    if (NotificationManager.instance) return NotificationManager.instance
+    if (NotificationManager.#instance) return NotificationManager.#instance
 
-    NotificationManager.instance = this
+    NotificationManager.#instance = this
     this.notifications = []
     this.#uid = 0
     this.#notificationDefaults = {