abrites-vue-ui v1.0.12

About The Project

Custom Vue components, directives, composables and style library intended to be used within Abrites Ltd. Besides the common UI library components it provides conveninet wrappers over leaflet map, ChartJS charts and SortableJS.

Currently hosted on TO BE HOSTED

Built With

• vite
• Chart.js
• Leaflet
• SortableJS
• Flatpickr

Usage

To get a local copy up and running follow these simple example steps.

Install the library in new or existing project:

npm install abrites-vue-ui

Register the library globaly in your app.js/server.ts

import { createApp } from "vue";
import App from "./App.vue";
import ui from "abrites-vue-ui";

createApp(App).use(ui).mount("#app");

Or import only the needed components in your view.

Use the components:

<template>

  <AbritesButton large>
    <span class="txt">Large</span>
    <AbritesIcon icon="arrow_forward"></AbritesIcon>
  </AbritesButton>

</template>

<script lang="ts" setup>
  //your logic...
</script>;

<style>
  //your styles...
</style>

For detailed explanation and examples check out the awesome DOCUMENTATION TO BE HOSTED

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Open a issue with request.

Prerequisites

• Vue
• Chart.js for Chart components
• Leaflet for Map component
• SortableJS Drag and Drop component
• Flatpickr for Datepicker and DatepickerInput components

Working with the library

To build the documentation

npm run build-docs

To build the library

npm run build

To run locally the documentation page

npm run dev