@muffled-ui/react 1.0.21
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/LICENSE +21 -0
- package/README.md +52 -0
- package/dist/index.d.mts +690 -0
- package/dist/index.d.ts +690 -0
- package/dist/index.js +4476 -0
- package/dist/index.mjs +4490 -0
- package/package.json +85 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Josh Batley
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="/public/logo-dark.svg#gh-dark-mode-only" height="128"/>
|
|
3
|
+
<img src="/public/logo-light.svg#gh-light-mode-only" height="128"/>
|
|
4
|
+
</p>
|
|
5
|
+
<div align="center">
|
|
6
|
+
|
|
7
|
+
[![Build][build-image]][build-url] [![NPM Version][version-image]][version-url] [![License][license-image]][license-url] [![Bundle Size][size-image]][size-url]
|
|
8
|
+
|
|
9
|
+
[build-image]: https://img.shields.io/github/actions/workflow/status/joshbatley/muffled-ui/publish-npm.yml
|
|
10
|
+
[build-url]: https://github.com/joshbatley/muffled-ui/actions
|
|
11
|
+
[version-image]: https://img.shields.io/npm/v/@muffled-ui/react
|
|
12
|
+
[version-url]: https://www.npmjs.com/package/@muffled-ui/react
|
|
13
|
+
[license-image]: https://img.shields.io/github/license/joshbatley/muffled-ui
|
|
14
|
+
[license-url]: https://github.com/joshbatley/muffled-ui/blob/main/LICENSE
|
|
15
|
+
[size-image]: https://img.shields.io/bundlephobia/min/%40muffled-ui%2Freact%40latest
|
|
16
|
+
[size-url]: https://bundlephobia.com/package/@muffled-ui/react
|
|
17
|
+
|
|
18
|
+
</div>
|
|
19
|
+
|
|
20
|
+
## Getting Started
|
|
21
|
+
|
|
22
|
+
### Installation methods
|
|
23
|
+
|
|
24
|
+
There are a few methods to choose from depending on your usage for muffled-ui
|
|
25
|
+
|
|
26
|
+
##### Install tailwind
|
|
27
|
+
|
|
28
|
+
Follow this official set-up [guide](https://tailwindcss.com/docs/guides/create-react-app) to get tailwind working within your react application.
|
|
29
|
+
|
|
30
|
+
##### Install muffled-ui
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
npm/yarn install @muffled-ui/react
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Package used
|
|
37
|
+
|
|
38
|
+
- React - Framework of choice
|
|
39
|
+
- Typescript - Types!!!
|
|
40
|
+
- Heroicons - for the few icons needed
|
|
41
|
+
- Downshift - a easy to use API for our select element
|
|
42
|
+
- React-datepicker - for the datepicker api
|
|
43
|
+
- Date-fns - the datepicker date library of choice
|
|
44
|
+
- Prism-react-renderer & react-simple-code-editor - for the code editor and syntax highlighter
|
|
45
|
+
- React-dropzone - for the file uploader
|
|
46
|
+
- React-spring - for any animation/transitions
|
|
47
|
+
- React-popper - for tooltip and popover API
|
|
48
|
+
- Storybooks - for the docs
|
|
49
|
+
|
|
50
|
+
## License
|
|
51
|
+
|
|
52
|
+
This library is MIT licensed.
|