diff --git a/docs/pages/components/icon.md b/docs/pages/components/icon.md index 51b579d..4314f7d 100644 --- a/docs/pages/components/icon.md +++ b/docs/pages/components/icon.md @@ -200,113 +200,46 @@ To register an additional icon library, use the `registerIconLibrary()` function If necessary, a mutator function can be used to mutate the SVG element before rendering. This is necessary for some libraries due to the many possible ways SVGs are crafted. For example, icons should ideally inherit the current text color via `currentColor`, so you may need to apply `fill="currentColor` or `stroke="currentColor"` to the SVG element using this function. -Here's an example that registers an icon library located in the `/assets/icons` directory. - -```html - -``` - -To display an icon, set the `library` and `name` attributes of an `` element. - -```html - - -``` - -If an icon is used before registration occurs, it will be empty initially but shown when registered. - The following examples demonstrate how to register a number of popular, open source icon libraries via CDN. Feel free to adapt the code as you see fit to use your own origin or naming conventions. -### OxyIcons +### Sonr Icons -Custom Sonr Icons. +Icons sourced from our internal style guide. + +> These are pre-packaged with Nebula and are not available for custom registration. ```html:preview
- - - - - - + + + + + +
``` -### Boxicons +### Crypto Icons -This will register the [Boxicons](https://boxicons.com/) library using the jsDelivr CDN. This library has three variations: regular (`bx-*`), solid (`bxs-*`), and logos (`bxl-*`). A mutator function is required to set the SVG's `fill` to `currentColor`. +A collection of icons for cryptocurrencies which are tradeable on the Sonr network. Provide the +All Caps ticker symbol for the icon. -Icons in this library are licensed under the [Creative Commons 4.0 License](https://github.com/atisawd/boxicons#license). - -```html:preview - - -
- - - - - - -
- - - - - - -
- - - - - - -
-``` - -### Lucide - -This will register the [Lucide](https://lucide.dev/) icon library using the jsDelivr CDN. This project is a community-maintained fork of the popular [Feather](https://feathericons.com/) icon library. - -Icons in this library are licensed under the [MIT License](https://github.com/lucide-icons/lucide/blob/master/LICENSE). +> These are pre-packaged with Nebula and are not available for custom registration. ```html:preview
- - - - - - + + + + + + + + + + +
- - ``` ### Font Awesome @@ -355,331 +288,6 @@ Icons in this library are licensed under the [Font Awesome Free License](https:/ ``` -### Heroicons - -This will register the [Heroicons](https://heroicons.com/) library using the jsDelivr CDN. - -Icons in this library are licensed under the [MIT License](https://github.com/tailwindlabs/heroicons/blob/master/LICENSE). - -```html:preview - - -
- - - - - - -
-``` - -### Iconoir - -This will register the [Iconoir](https://iconoir.com/) library using the jsDelivr CDN. - -Icons in this library are licensed under the [MIT License](https://github.com/lucaburgio/iconoir/blob/master/LICENSE). - -```html:preview - - -
- - - - - - -
-``` - -### Ionicons - -This will register the [Ionicons](https://ionicons.com/) library using the jsDelivr CDN. This library has three variations: outline (default), filled (`*-filled`), and sharp (`*-sharp`). A mutator function is required to polyfill a handful of styles we're not including. - -Icons in this library are licensed under the [MIT License](https://github.com/ionic-team/ionicons/blob/master/LICENSE). - -```html:preview - - -
- - - - - - -
- - - - - - -
- - - - - - -
-``` - -### Jam Icons - -This will register the [Jam Icons](https://jam-icons.com/) library using the jsDelivr CDN. This library has two variations: regular (default) and filled (`*-f`). A mutator function is required to set the SVG's `fill` to `currentColor`. - -Icons in this library are licensed under the [MIT License](https://github.com/michaelampr/jam/blob/master/LICENSE). - -```html:preview - - -
- - - - - - -
- - - - - - -
-``` - -### Material Icons - -This will register the [Material Icons](https://material.io/resources/icons/?style=baseline) library using the jsDelivr CDN. This library has three variations: outline (default), round (`*_round`), and sharp (`*_sharp`). A mutator function is required to set the SVG's `fill` to `currentColor`. - -Icons in this library are licensed under the [Apache 2.0 License](https://github.com/google/material-design-icons/blob/master/LICENSE). - -```html:preview - - -
- - - - - - -
- - - - - - -
- - - - - - -
-``` - -### Remix Icon - -This will register the [Remix Icon](https://remixicon.com/) library using the jsDelivr CDN. This library groups icons by categories, so the name must include the category and icon separated by a slash, as well as the `-line` or `-fill` suffix as needed. A mutator function is required to set the SVG's `fill` to `currentColor`. - -Icons in this library are licensed under the [Apache 2.0 License](https://github.com/Remix-Design/RemixIcon/blob/master/License). - -```html:preview - - -
- - - - - - -
- - - - - - -
-``` - -### Tabler Icons - -This will register the [Tabler Icons](https://tabler-icons.io/) library using the jsDelivr CDN. This library features over 1,950 open source icons. - -Icons in this library are licensed under the [MIT License](https://github.com/tabler/tabler-icons/blob/master/LICENSE). - -```html:preview - - -
- - - - - - -
- - - - - - -
-``` - -### Unicons - -This will register the [Unicons](https://iconscout.com/unicons) library using the jsDelivr CDN. This library has two variations: line (default) and solid (`*-s`). A mutator function is required to set the SVG's `fill` to `currentColor`. - -Icons in this library are licensed under the [Apache 2.0 License](https://github.com/Iconscout/unicons/blob/master/LICENSE). Some of the icons that appear on the Unicons website, particularly many of the solid variations, require a license and are therefore not available in the CDN. - -```html:preview - - -
- - - - - - -
- - - - - - -
-``` - -### Customizing the Default Library - -The default icon library contains over 1,300 icons courtesy of the [Bootstrap Icons](https://icons.getbootstrap.com/) project. These are the icons that display when you use `` without the `library` attribute. If you prefer to have these icons resolve elsewhere or to a different icon library, register an icon library using the `default` name and a custom resolver. - -This example will load the same set of icons from the jsDelivr CDN instead of your local assets folder. - -```html - -``` - -#### Customize the default library to use SVG sprites - -To improve performance you can use a SVG sprites to avoid multiple trips for each SVG. The browser will load the sprite sheet once and then you reference the particular SVG within the sprite sheet using hash selector. - -As always, make sure to benchmark these changes. When using HTTP/2, it may in fact be more bandwidth-friendly to use multiple small requests instead of 1 large sprite sheet. - -:::danger -When using sprite sheets, the `sl-load` and `sl-error` events will not fire. -::: - -:::danger -For security reasons, browsers may apply the same-origin policy on `` elements located in the `` shadow DOM and may refuse to load a cross-origin URL. There is currently no defined way to set a cross-origin policy for `` elements. For this reason, sprite sheets should only be used if you're self-hosting them. -::: - -```html:preview - - -
- - -
-``` - ### Customizing the System Library The system library contains only the icons used internally by Nebula components. Unlike the default icon library, the system library does not rely on physical assets. Instead, its icons are hard-coded as data URIs into the resolver to ensure their availability. @@ -882,3 +490,7 @@ If you want to change the icons Nebula uses internally, you can register an icon } } + +``` + +```