Skip to content

Getting Started

Prerequisites

  • Node.js 18.x or higher
  • npm, yarn, or pnpm package manager (npm is installed with Node.js out of the box)

Install Bamboo

bash
npm install @mrksbnc/bamboo
bash
yarn add @mrksbnc/bamboo
bash
pnpm add @mrksbnc/bamboo
bash
bun add @mrksbnc/bamboo

Usage

  1. Register the library css file in your root entry.
ts
// main.ts
import { createApp } from 'vue'
import App from './App.vue'

// Import the main library CSS file
import '@mrksbnc/bamboo/lib.css'

createApp(App).mount('#app')
  1. Import the components you want to use.
ts
<template>
	<bo-text value="Hello Bamboo" />
	<bo-icon :icon="Icon.heart" />
	<bo-icon :icon="Icon.star" custom-color="var(--blue-600)" />
</template>

<script setup lang="ts">
	import { BoText, BoIcon, Icon } from '@mrksbnc/bamboo'
</script>