Skip to content

Nethrenial/nethren-ui-vue

Folders and files

NameName
Last commit message
Last commit date

Latest commit

dd3ff74 · Oct 29, 2023

History

30 Commits
Jul 7, 2023
Oct 29, 2023
Jul 7, 2023
Jul 7, 2023
Jul 7, 2023
Jul 7, 2023
Jul 7, 2023
Jul 25, 2023
Jul 25, 2023
Oct 29, 2023
Jul 7, 2023
Jul 7, 2023
Jul 7, 2023
Oct 29, 2023

Repository files navigation

Nethren-UI (Vue 3 version)

Nethren UI is component library built from ground for vue and react.

Features

  • Built with typescript
  • Fully customizable color pallete
  • User friendly and accessible components

What's the inspiration

This project was inspired from several component librarie, mainly Chakra UI and Vuesax 4.

Currently vue 3 version is in development and you can install the alpha version from here.

Getting started

For the full documentation, please visit @nethren-ui/vue documentation website !

npm install @nethren-ui/vue
# or
yarn add @nethren-ui/vue
#or
pnpm add @nethren-ui/vue

After that, all you have to do to setup it is, call the setColorPallete function (either in app.vue or main.js/ts) and import the css file.

// in main.ts or in App.vue script(script setup or legacy) block
import {setColorPallete} from '@nethren-ui/vue';
import "@nethren-ui/vue/dist/style.css";

// call the function
setColorPallete();

And in each individula SFC component, you can import the relevant component directly (tree-shakable) and use it.

<script setup lang="ts">
import { NButton } from '@nethren-ui/vue'
</script>

<template>
    <NButton>Button 1</NButton>
    <n-button>This one also works</n-button>
</template>

About

Repository for vue version of nethren-ui

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published