@nasp/icons
Version:
Universal design and icon system for NASP Asset Studio, with NaspScript language support.
61 lines (44 loc) • 1.3 kB
Markdown
# NASPIcon API
The universal icon API for the NASP Design Kit. Use for SVG, DOM, React, and dynamic icon access.
## Methods
### init(path = 'icons.json')
Loads icon data from JSON. Returns a Promise.
```js
await NASPIcon.init();
```
### autoInit(path = 'icons.json')
Auto-initialize in browser. Returns a Promise.
### get(name, props = {})
Returns SVG string for an icon.
```js
NASPIcon.get('Search', { size: 32, color: '#5865f2' });
```
### element(name, props = {})
Returns a DOM element for an icon (browser only).
### html(name, props = {})
Returns SVG as HTML string.
### appendTo(name, props, parent)
Appends icon to a DOM parent.
### react(name, props = {})
Returns a React element for an icon.
### listIcons()
Returns an array of all icon names.
### hasIcon(name)
Returns true if the icon exists.
### parse()
Replaces all <nasp-icon> tags in the DOM with SVGs (browser only).
---
## Usage Examples
```js
import { NASPIcon } from 'nasp-icons';
NASPIcon.get('Search', { size: 32, color: '#5865f2' });
NASPIcon.listIcons();
```
```js
import { Search } from 'nasp-icons/icons';
document.body.innerHTML = Search;
```
```js
import { SearchIcon } from 'nasp-icons/icons/react';
<SearchIcon size={32} color="#5865f2" />
```