README.md31 lines · main
1# ./packages/icons
2
3This package contains custom Briven icons that can be used alongside other icon libraries.
4
5## Documentation
6
7**For complete documentation, usage examples, and guidelines, see the [Design System](../../apps/design-system/content/docs/icons.mdx)**
8
9## Quick start
10
11```jsx
12import { Auth, BucketAdd, Database } from 'icons'
13
14function MyComponent() {
15 return (
16 <>
17 <BucketAdd size={24} className="text-foreground-muted" />
18 <Database size={16} strokeWidth={1} />
19 <Auth size={20} />
20 </>
21 )
22}
23```
24
25### Adding new custom icons
26
271. Add your SVG file to `src/raw-icons/` (kebab-case name)
282. Run `npm run build:icons` in this directory
293. Import and use your new icon
30
31For detailed instructions, examples, and troubleshooting, see the [Design System](../../apps/design-system/content/docs/icons.mdx).
Preview

./packages/icons

This package contains custom Briven icons that can be used alongside other icon libraries.

Documentation

For complete documentation, usage examples, and guidelines, see the Design System

Quick start

import { Auth, BucketAdd, Database } from 'icons'

function MyComponent() {
  return (
    <>
      <BucketAdd size={24} className="text-foreground-muted" />
      <Database size={16} strokeWidth={1} />
      <Auth size={20} />
    </>
  )
}

Adding new custom icons

  1. Add your SVG file to src/raw-icons/ (kebab-case name)
  2. Run npm run build:icons in this directory
  3. Import and use your new icon

For detailed instructions, examples, and troubleshooting, see the Design System.