groovinads-ui 1.1.0 → 1.1.2
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 +23 -5
- package/package.json +12 -1
- package/assets/groovinads-logo.png +0 -0
package/README.md
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
|
-
<
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://www.groovinads.com/">
|
|
3
|
+
<img src="https://ui.groovinads.com/assets/groovinads-logo.png" alt="Groovinads logo" width="200">
|
|
4
|
+
</a>
|
|
5
|
+
</p>
|
|
4
6
|
|
|
5
7
|
# Groovinads UI
|
|
6
8
|
Groovinads UI is a React component library that provides ready-to-use UI elements based on the Groovinads UI kit. This library is designed to facilitate the implementation of common UI elements in Groovinads applications.
|
|
7
9
|
|
|
8
|
-
## Included
|
|
10
|
+
## Included components
|
|
9
11
|
|
|
10
12
|
The library includes the following components:
|
|
11
13
|
|
|
@@ -24,7 +26,7 @@ The library includes the following components:
|
|
|
24
26
|
- **npm** (v18 or higher).
|
|
25
27
|
- [Font Awesome](https://fontawesome.com/) icons must be included in the project.
|
|
26
28
|
|
|
27
|
-
### Important: Use of additional CSS libraries
|
|
29
|
+
### ⚠️ Important: Use of additional CSS libraries
|
|
28
30
|
When utilizing external libraries that require additional CSS styles, it is important to ensure that these styles are not added directly to individual components.
|
|
29
31
|
Instead, they should be included in the `index.html` file of your project. This ensures that all styles are loaded correctly and in the desired order. Specifically, make sure that the CSS file `https://ui.groovinads.com/styles.min.css` is the last one to be loaded to avoid style conflicts and ensure that the default Groovinads styles have the proper priority.
|
|
30
32
|
|
|
@@ -78,6 +80,8 @@ import { Button } from 'groovinads-ui';
|
|
|
78
80
|
|
|
79
81
|
#### Checkbox
|
|
80
82
|
```jsx
|
|
83
|
+
import { Checkbox } from 'groovinads-ui';
|
|
84
|
+
|
|
81
85
|
<Checkbox
|
|
82
86
|
className={'mb-5'}
|
|
83
87
|
id={'checkbox'}
|
|
@@ -98,6 +102,8 @@ import { Button } from 'groovinads-ui';
|
|
|
98
102
|
|
|
99
103
|
#### Input
|
|
100
104
|
```jsx
|
|
105
|
+
import { Input } from 'groovinads-ui';
|
|
106
|
+
|
|
101
107
|
<Input
|
|
102
108
|
className={'mb-5'}
|
|
103
109
|
helpText={'This is a help text'}
|
|
@@ -128,6 +134,8 @@ import { Button } from 'groovinads-ui';
|
|
|
128
134
|
|
|
129
135
|
#### Radio
|
|
130
136
|
```jsx
|
|
137
|
+
import { Radio } from 'groovinads-ui';
|
|
138
|
+
|
|
131
139
|
<Radio
|
|
132
140
|
className={'mb-5'}
|
|
133
141
|
id={'radio'}
|
|
@@ -149,6 +157,8 @@ import { Button } from 'groovinads-ui';
|
|
|
149
157
|
|
|
150
158
|
#### Switch
|
|
151
159
|
```jsx
|
|
160
|
+
import { Switch } from 'groovinads-ui';
|
|
161
|
+
|
|
152
162
|
<Switch
|
|
153
163
|
className={'mb-5'}
|
|
154
164
|
name={'switch'}
|
|
@@ -171,6 +181,8 @@ import { Button } from 'groovinads-ui';
|
|
|
171
181
|
|
|
172
182
|
#### Textarea
|
|
173
183
|
```jsx
|
|
184
|
+
import { Textarea } from 'groovinads-ui';
|
|
185
|
+
|
|
174
186
|
<Textarea
|
|
175
187
|
className={'mb-5'}
|
|
176
188
|
label={'Textarea label'}
|
|
@@ -196,6 +208,8 @@ import { Button } from 'groovinads-ui';
|
|
|
196
208
|
### Labels
|
|
197
209
|
#### LoginSource
|
|
198
210
|
```jsx
|
|
211
|
+
import { LoginSource } from 'groovinads-ui';
|
|
212
|
+
|
|
199
213
|
<LoginSource logo={'groovinads'} />
|
|
200
214
|
```
|
|
201
215
|
|
|
@@ -205,6 +219,8 @@ import { Button } from 'groovinads-ui';
|
|
|
205
219
|
|
|
206
220
|
#### PillComponent
|
|
207
221
|
```jsx
|
|
222
|
+
import { PillComponent } from 'groovinads-ui';
|
|
223
|
+
|
|
208
224
|
<PillComponent color='green'>
|
|
209
225
|
Active
|
|
210
226
|
</PillComponent>
|
|
@@ -219,6 +235,8 @@ import { Button } from 'groovinads-ui';
|
|
|
219
235
|
|
|
220
236
|
#### StatusIcon
|
|
221
237
|
```jsx
|
|
238
|
+
import { StatusIcon } from 'groovinads-ui';
|
|
239
|
+
|
|
222
240
|
<StatusIcon status={1} />
|
|
223
241
|
```
|
|
224
242
|
| Property | Type | Options | Default | Description |
|
package/package.json
CHANGED
|
@@ -1,8 +1,19 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "groovinads-ui",
|
|
3
|
-
"
|
|
3
|
+
"description": "Groovinads UI is a React component library designed exclusively for Groovinads applications. It provides ready-to-use UI elements styled according to Groovinads design guidelines to facilitate rapid development.",
|
|
4
|
+
"version": "1.1.2",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"css",
|
|
7
|
+
"sass",
|
|
8
|
+
"groovinads",
|
|
9
|
+
"responsive",
|
|
10
|
+
"front-end",
|
|
11
|
+
"components"
|
|
12
|
+
],
|
|
13
|
+
"homepage": "https://www.groovinads.com/",
|
|
4
14
|
"main": "dist/index.js",
|
|
5
15
|
"module": "dist/index.es.js",
|
|
16
|
+
"style": "https://ui.groovinads.com/styles.min.css",
|
|
6
17
|
"repository": "git@bitbucket.org:groovinads/react-components.git",
|
|
7
18
|
"author": "Pablo Piñero <pablo.piniero@groovinads.com>",
|
|
8
19
|
"license": "MIT",
|
|
Binary file
|