@embeddr/react-ui 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,29 +1,67 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center"><a name="readme-top"></a>
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<img height="120" src="https://embeddr.net/embeddr_logo_transparent.png">
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
<h1>Embeddr React Components</h1>
|
|
6
|
+
</div>
|
|
7
|
+
|
|
8
|
+
[![npm downloads][npm-downloads-image]][embeddr-react-ui-url]
|
|
9
|
+
[![embeddr-react-ui version][embeddr-react-ui-image]][embeddr-react-ui-url]
|
|
10
|
+
|
|
11
|
+
[![pypi version][pypi-image]][pypi-url]
|
|
12
|
+
[![embeddr-core version][embeddr-core-image]][embeddr-core-url]
|
|
13
|
+
|
|
14
|
+
[![embeddr-frontend][embeddr-frontend-image]][embeddr-frontend-url]
|
|
15
|
+
|
|
16
|
+
[![license][license-image]][license-url]
|
|
17
|
+
|
|
18
|
+
[npm-downloads-image]: https://img.shields.io/npm/d18m/%40embeddr%2Freact-ui?style=flat-square&&logo=Npm&logoColor=%23cc3534&label=Downloads&labelColor=%232f2f2f&color=%234f4f4f
|
|
19
|
+
|
|
20
|
+
[pypi-image]: https://img.shields.io/pypi/v/embeddr-cli?style=flat-square&&logo=Python&logoColor=%23ffd343&label=cli&labelColor=%232f2f2f&color=%234f4f4f
|
|
21
|
+
[pypi-url]: https://pypi.org/project/embeddr-cli
|
|
22
|
+
|
|
23
|
+
[embeddr-core-image]: https://img.shields.io/pypi/v/embeddr-core?style=flat-square&logo=Python&logoColor=%23ffd343&label=core&labelColor=%232f2f2f&color=%234f4f4f
|
|
24
|
+
[embeddr-core-url]: https://pypi.org/project/embeddr-core
|
|
25
|
+
|
|
26
|
+
[embeddr-react-ui-image]: https://img.shields.io/npm/v/%40embeddr%2Freact-ui?style=flat-square&logo=React&logoColor=%61DBFB&label=react-ui&labelColor=%232f2f2f&color=%234f4f4f
|
|
27
|
+
[embeddr-react-ui-url]: https://www.npmjs.com/package/@embeddr/react-ui
|
|
28
|
+
|
|
29
|
+
[embeddr-frontend-image]: https://img.shields.io/npm/v/%40embeddr%2Freact-ui?style=flat-square&logo=React&logoColor=%61DBFB&label=frontend&labelColor=%232f2f2f&color=%234f4f4f
|
|
30
|
+
[embeddr-frontend-url]: https://github.com/embeddr-net/embeddr-frontend
|
|
31
|
+
|
|
32
|
+
[license-image]: https://img.shields.io/github/license/embeddr-net/embeddr-cli?style=flat-square&logoColor=%232f2f2f&labelColor=%232f2f2f&color=%234f4f4f
|
|
33
|
+
[license-url]: https://pypi.org/project/embeddr-cli
|
|
6
34
|
|
|
7
35
|
> [!WARNING]
|
|
8
|
-
> UNDER DEVELOPMENT
|
|
9
36
|
>
|
|
10
|
-
>
|
|
11
|
-
|
|
12
|
-
|
|
37
|
+
> You do not need this if you want to use Embeddr
|
|
38
|
+
>
|
|
39
|
+
> This repo is for development only.
|
|
40
|
+
>
|
|
41
|
+
> Please use [embeddr-cli](https://github.com/embeddr-net/embeddr-cli)
|
|
13
42
|
|
|
14
43
|
## Description
|
|
15
44
|
|
|
16
45
|
This repo contains React Components used throughout Embeddr.
|
|
17
46
|
|
|
47
|
+
## Currently Used In
|
|
48
|
+
|
|
49
|
+
- [Embeddr CLI's Frontend](https://github.com/embeddr-net/embeddr-frontend)
|
|
50
|
+
- [Embeddr ComfyUI Extension](https://github.com/embeddr-net/embeddr-comfyui)
|
|
51
|
+
|
|
18
52
|
## Examples
|
|
19
53
|
|
|
54
|
+
### Themed [shadcn](https://ui.shadcn.com/) Components
|
|
55
|
+
|
|
20
56
|
### 3D UMAP Explorer (Coming Soon)
|
|
21
57
|
|
|
22
|
-
|
|
58
|
+
|
|
23
59
|
|
|
24
|
-
###
|
|
60
|
+
### 2D UMAP Explorer (Coming Soon)
|
|
25
61
|
|
|
26
62
|
### React Hooks
|
|
27
63
|
|
|
28
|
-
- **useExternalNav** - Provides the user a warning before navigating to a new site.
|
|
29
64
|
- **useImageDialog** - Provides the user with a lightbox to view images and galleries.
|
|
65
|
+
|
|
66
|
+
- **useExternalNav** - Provides the user a warning before navigating to a new site.
|
|
67
|
+
|