@bitcoinbeachtravemuende/bbt-logo
v0.2.2
Published
Animated logo of Bitcoin Beach Travemünde provided as a web component.
Downloads
9
Keywords
Readme
<bbt-logo />
Animated logo of Bitcoin Beach Travemünde provided as a web component.
https://github.com/BitcoinBeachTravemuende/bbt-logo-webcomponent/assets/47693/0e14e78b-0cd2-4d10-bea5-7ce62b67356b
Features
- Customize size and colors as you like
- SVG based
- Plain Web Component without any library
- Small bundle size:
9.94 kB │ gzip: 3.17 kB
- Supported by modern browsers
- Use it with your favourite web framework
Usage
Installation
Use your favourite Node package manager to install bbt-logo
web component.
npm
npm install @bitcoinbeachtravemuende/bbt-logo
bun
bun add @bitcoinbeachtravemuende/bbt-logo
pnpm
pnpm add @bitcoinbeachtravemuende/bbt-logo
yarn
yarn add @bitcoinbeachtravemuende/bbt-logo
Use bundle via jsdelivr
TBD
Properties
size: string
:px
orem
, eg.size="300px"
orsize="8em"
fill: string
: Colorname
orhex
values, eg.fill="white"
orfill="#FFF"
stroke: string
: colorname
orhex
values, eg.fill="black"
orfill="#000"
Examples
Default
<bbt-logo />
Custom colors
<bbt-logo stroke="white" fill="black"></bbt-logo>
Custom size
<bbt-logo size="300px"></bbt-logo>
All custom values
<bbt-logo size="300px" stroke="black" fill="white"></bbt-logo>
Build
Requirements
Nix (recommended)
Install Nix
Other
Install pnpm
or any other Node package manager (bun
, npm
, yarn
or whatever)
Local build
- Install dependencies (command might be different for other package manager)
pnpm install
- Local build
pnpm dev
Open http://localhost:5173
- Release build
pnpm build
Build sources land into dist
folder.
Storybook
pnpm storybook
Open http://localhost:6006