agerix/iconify
2
0
Fork 0
mirror of https://github.com/iconify/iconify.git synced 2024-12-05 02:33:16 +00:00
Code Issues Releases Activity

Update readme

Browse Source
This commit is contained in:
Vjacheslav Trushkin 2022-05-13 22:25:29 +03:00
parent a2591dbe36
commit 38926d087a
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -53,7 +53,7 @@ Main packages:
### Iconify icon components
Directory `component` contains Iconify icon components and SVG framework.
Directory `components` contains Iconify icon components and SVG framework.
| Package | Usage |
| ---------------------------------------- | ------ |
@ -64,6 +64,21 @@ Directory `component` contains Iconify icon components and SVG framework.
| [Svelte component](./components/svelte/) | Svelte |
| [Ember component](./components/ember/) | Ember |
#### Deprecation notice
Components in directory `components` are slowly phased out in favor of `iconify-icon` web component. Functionality is identical, but web component has some advantages:
- No framework specific shenanigans. Events and attributes are supported for all frameworks.
- Works better with SSR (icon is rendered only in browser, but because icon is contained in shadow DOM, it does not cause hydration problems).
- Better interoperability. All parts of applicaiton reuse same web component, even if those parts are written in different frameworks.
Deprecation status:
- SVG Framework: can be replaced with `iconify-icon`.
- Ember component: can be replaced with `iconify-icon`, does not require Ember specific wrapper.
To import web component, just import it once in your script, as per [`iconify-icon` README file](./iconify-icon/icon/README.md).
#### Demo
Directory `components-demo` contains demo packages that show usage of icon components.