Skip to content
On this page

@obewds/tw-bg-palette-default ​

Welcome to the docs page for OBE:WDS's twBgPaletteDefault component for Vue.js!


⚠️ Project Depreciated ⚠️ ​

This project has been depreciated. Use VueVentus (via github or via npm), which is the result of this project, and has this functionality along with much more.


Installation ​

bash
npm install @obewds/tw-bg-palette-default --save-dev

Object Schema ​

The object returned when importing Tailwind CSS background default color palette has the following schema:

javascript
{
    'default': {
        colors: {
            'default': '',
            'error': '...',
            'primary': '...',
            'secondary': '...',
            'success': '...',
        },
    },
}

Use Example ​

html
<script setup lang="ts">

    import { twBgPaletteDefault } from '@obewds/tw-bg-palette-default'

    const props = defineProps({
        bgClasses: {
            type: String,
            default: twBgPaletteDefault.default.colors.primary,
        },
    })

</script>

<template>

    <div :class="bgClasses">
        {{ bgClasses }}
    </div>

</template>

Uninstall ​

bash
npm uninstall @obewds/tw-bg-palette-default