Giter Club home page Giter Club logo

vuetify-coloring's Introduction

vuetify-coloring

npm version npm downloads

Gives SPA users ability to change colors of Vuetify interface elements

Features

  • Works directly with css variables
  • Stores user settings in browser localStorage
  • Integrated lightweight developer tool

Live demo

Setup

  • Install package
npm install vuetify-coloring # or yarn add vuetify-coloring
new Vuetify({
  theme: {
    options: { customProperties: true },
  },
})
  • Define custom colors for groups of elements. For example header, panel and background
new Vuetify({
  theme: {
    options: {
      customProperties: true
    },
    dark: true,
    themes: {
      dark: {
        primary: "#001122",
        header: "#334455",
        panel: "#667788",
        background: "#99aabb"
      },
      light: {
        primary: "#001122",
        header: "#334455",
        panel: "#667788",
        background: "#99aabb"
      }
    }
  }
});
  • Import VColoring component to your app
import VColoring from "vuetify-coloring";

export default {
  components: {
    VColoring
  },
  data: () => ({
    colors: [ 'primary', 'header', 'panel', 'background']
  })
};
  • Add VColoring to your template
 <VColoring :colors="colors" />

Usage

Assign colors to elements

The easiest way to assign a color to an element is to use the color prop

 <v-app-bar color="header">

If the element does not have such a prop, then you can add the class

 <v-list-item-content class="panel">

If none of the methods worked, then you need to directly add the css rule to your <style> section. Integrated tool will help you.

Background on demo page has been set in this way

Presets

import Presets from "./presets.json";

export default {
  components: {
    VColoring
  },
  data: () => ({
    colors: [ 'primary', 'header', 'panel', 'background'],
    presets: Presets
  })
};
 <VColoring
    :colors="colors"
    :presets="presets"
 />

Example presets.json file is located here: node_modules/vuetify-coloring/src/lib/presets.json

Developer tool

To enable developer tool feature add tools prop to template

 <VColoring
    :colors="colors"
    :presets="presets"
    tool
 />

or separately

in this case dont forget to import it too

<VColoringTool :colors="colors" />

To see how it works, go to tool demo page

VColoring props list

Name Type Default Description
colors Array [] List of custom colors
presets Object {} Presets
tool Boolean false Enables tool feature
disable-picker Boolean false Disables color picker

VColoringTool props list

Name Type Default Description
colors Array [] List of custom colors

Copyright (c) Sergey Demidov [email protected]

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.