Skip to content

bitrix24/b24ui

Repository files navigation

Bitrix24 UI

npm version npm downloads License Bitrix24 UI

Bitrix24 UI for developing web applications REST API for NUXT & VUE

Find more details in the documentation

Documentation

Visit https://bitrix24.github.io/b24ui/ to explore the documentation.

Installation

pnpm add @bitrix24/b24ui-nuxt @bitrix24/b24icons-vue tailwindcss
yarn add @bitrix24/b24ui-nuxt @bitrix24/b24icons-vue tailwindcss
npm install @bitrix24/b24ui-nuxt @bitrix24/b24icons-vue tailwindcss
yarn add @bitrix24/b24ui-nuxt @bitrix24/b24icons-vue tailwindcss

Nuxt

  1. Add the Bitrix24 UI module in your nuxt.config.ts:
export default defineNuxtConfig({
  modules: ['@bitrix24/b24ui-nuxt'],
  css: ['~/assets/css/main.css']
})
  1. Import Tailwind CSS and Bitrix24 UI in your CSS:
@import "tailwindcss";
@import "@bitrix24/b24ui-nuxt";

Learn more in the installation guide.

Vue

  1. Add the Bitrix24 UI Vite plugin in your vite.config.ts:
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import bitrix24UIPluginVite from '@bitrix24/b24ui-nuxt/vite'

export default defineConfig({
  plugins: [
    vue(),
    bitrix24UIPluginVite()
  ]
})
  1. Use the Bitrix24 UI Vue plugin in your main.ts:
import './assets/css/main.css'

import { createApp } from 'vue'
import { createRouter, createWebHistory } from 'vue-router'
import b24UiPlugin from '@bitrix24/b24ui-nuxt/vue-plugin'
import App from './App.vue'

const app = createApp(App)

const router = createRouter({
  routes: [],
  history: createWebHistory()
})

app.use(router)
app.use(b24UiPlugin)

app.mount('#app')
  1. Import Tailwind CSS and Bitrix24 UI in your CSS:
@import "tailwindcss";
@import "@bitrix24/b24ui-nuxt";

Learn more in the installation guide.

Contribution

Thank you for considering contributing to Bitrix24 UI. Here are a few ways you can get involved:

  • Reporting Bugs: If you come across any bugs or issues, please check out the reporting bugs guide to learn how to submit a bug report.
  • Suggestions: Have any thoughts to enhance Bitrix24 UI? We'd love to hear them! Check out the contribution guide to share your suggestions.

Tip

We provide contributing guidelines through AGENTS.md for AI assistants to help you contribute to Bitrix24 UI. It is automatically picked up by all AI coding agents and guides through component structure, theming patterns, testing conventions, and documentation guidelines.

Credits

About

Bitrix24 UI-Kit for REST API web-application development

Resources

License

Stars

Watchers

Forks

Contributors