dash_mantine_components 0.11.0-a0
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 +94 -0
- package/dash_mantine_components/dash_mantine_components.js +2 -0
- package/dash_mantine_components/metadata.json +35286 -0
- package/package.json +58 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2022 Snehil Vijay
|
|
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,94 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/snehilvj/dash-mantine-components/master/assets/logo.png" alt="logo" width=300 >
|
|
3
|
+
</p>
|
|
4
|
+
<p align="center">
|
|
5
|
+
<img src="https://badgen.net/pypi/license/dash-mantine-components">
|
|
6
|
+
<a href="https://pypi.org/project/dash-mantine-components/">
|
|
7
|
+
<img src="https://badgen.net/pypi/v/dash-mantine-components">
|
|
8
|
+
</a>
|
|
9
|
+
<a href="https://discord.gg/KuJkh4Pyq5">
|
|
10
|
+
<img src="https://img.shields.io/badge/Chat%20on-Discord-%235865f2">
|
|
11
|
+
</a>
|
|
12
|
+
<img src="https://static.pepy.tech/personalized-badge/dash-mantine-components?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads">
|
|
13
|
+
</p>
|
|
14
|
+
|
|
15
|
+
Dash Mantine Components is an extensive (70+) Dash components library based on [Mantine](https://mantine.dev/) React Components Library. It makes it easier to create good quality dashboards with very well designed components out of the box.
|
|
16
|
+
|
|
17
|
+
[Documentation](https://dash-mantine-components.com)
|
|
18
|
+
|
|
19
|
+
<p align="center">
|
|
20
|
+
<img src="https://raw.githubusercontent.com/snehilvj/dash-mantine-components/master/assets/datepicker.gif">
|
|
21
|
+
</p>
|
|
22
|
+
|
|
23
|
+
### Table of contents
|
|
24
|
+
|
|
25
|
+
- [Installation](#installation)
|
|
26
|
+
- [Quickstart](#quickstart)
|
|
27
|
+
- [Contributing](#contributing)
|
|
28
|
+
- [TODO](#todo)
|
|
29
|
+
|
|
30
|
+
## Installation
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
pip install dash-mantine-components
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Quickstart
|
|
37
|
+
|
|
38
|
+
```python
|
|
39
|
+
import dash_mantine_components as dmc
|
|
40
|
+
from dash import Dash, Input, Output
|
|
41
|
+
|
|
42
|
+
app = Dash(__name__)
|
|
43
|
+
|
|
44
|
+
app.layout = html.Div(
|
|
45
|
+
[
|
|
46
|
+
dmc.DatePicker(id="datepicker", format="dddd, MMMM D, YYYY"),
|
|
47
|
+
dmc.Text(id="text"),
|
|
48
|
+
dmc.Button("Click Me!")
|
|
49
|
+
]
|
|
50
|
+
)
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
@app.callback(Output("text", "children"), Input("datepicker", "date"))
|
|
54
|
+
def datepicker(date):
|
|
55
|
+
return date
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
if __name__ == "__main__":
|
|
59
|
+
app.run_server(debug=True)
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Contributing
|
|
63
|
+
|
|
64
|
+
1. Join our [Discord](https://discord.gg/KuJkh4Pyq5) community.
|
|
65
|
+
|
|
66
|
+
2. Install virtual environment:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
python -m venv venv
|
|
70
|
+
source venv/bin/activate
|
|
71
|
+
pip install -r requirements.txt
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
3. Install npm dependencies
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
npm install
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
4. Add your new component in `src/lib/components`. Make sure to include it in the `src/lib/index.js` as well.
|
|
81
|
+
|
|
82
|
+
5. Ensure that component props are sorted in ascending order. Refer to existing components.
|
|
83
|
+
|
|
84
|
+
6. Build the components with the command: `npm run build`.
|
|
85
|
+
|
|
86
|
+
7. Once you are ready to commit, add a line in the CHANGELOG.md under one of these: Added, Changed, Deprecated, Removed, Fixed.
|
|
87
|
+
|
|
88
|
+
8. Raise a PR, including an example to reproduce the changes contributed by the PR.
|
|
89
|
+
|
|
90
|
+
## TODO
|
|
91
|
+
|
|
92
|
+
1. Add contributing guide.
|
|
93
|
+
2. Add testing.
|
|
94
|
+
3. Add lazy loading to the components.
|