https://github.com/metonym/svelte-baseui-icons

Uber Base UI SVG icons as Svelte components
https://github.com/metonym/svelte-baseui-icons

base base-web baseui icons svelte svelte-component svg

Last synced: about 1 month ago
JSON representation

Uber Base UI SVG icons as Svelte components

• Host: GitHub
• URL: https://github.com/metonym/svelte-baseui-icons
• Owner: metonym
• License: mit
• Created: 2020-04-26T23:27:14.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-11-30T01:28:54.000Z (almost 4 years ago)
• Last Synced: 2024-08-10T09:28:52.881Z (3 months ago)
• Topics: base, base-web, baseui, icons, svelte, svelte-component, svg
• Language: JavaScript
• Homepage: https://metonym.github.io/svelte-baseui-icons/
• Size: 104 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# svelte-baseui-icons

[![NPM][npm]][npm-url]

[![Build][build]][build-badge]

> Uber Base UI SVG icons as Svelte components.

This library builds icons from [Uber Base Web](https://github.com/uber/baseweb) as Svelte components with zero dependencies.

## Install

```bash

yarn add -D svelte-baseui-icons

# OR

npm i -D svelte-baseui-icons

```

## Usage

```svelte

  import { Alert, ArrowDown, Filter } from "svelte-baseui-icons";

```

Refer to [ICON_INDEX.md](ICON_INDEX.md) for a full list of icons.

## API

`$$restProps` are forwarded to the `svg` element.

### Forwarded events

- on:click

- on:mouseover

- on:mouseenter

- on:mouseout

- on:keydown

## Rendering using `svelte:component`

```svelte

  import * as icons from "svelte-baseui-icons";

{#each Object.keys(icons) as icon}

  


    

    {icon}

  

{/each}

```


## [Changelog](CHANGELOG.md)

## License

[MIT](LICENSE)

[npm]: https://img.shields.io/npm/v/svelte-baseui-icons.svg?color=blue

[npm-url]: https://npmjs.com/package/svelte-baseui-icons

[build]: https://travis-ci.com/metonym/svelte-baseui-icons.svg?branch=master

[build-badge]: https://travis-ci.com/metonym/svelte-baseui-icons