@symply.io/basic-components 1.0.0-alpha.3 → 1.0.0-alpha.4
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 +30 -30
- package/package.json +1 -1
package/README.md
CHANGED
@@ -33,7 +33,7 @@
|
|
33
33
|
|
34
34
|
It is available as an [npm package](https://www.npmjs.com/package/@symply.io/basic-components).
|
35
35
|
|
36
|
-
```
|
36
|
+
```shell
|
37
37
|
// with npm
|
38
38
|
npm install @symply.io/basic-components
|
39
39
|
|
@@ -58,9 +58,9 @@ Diglog component for alerts or confirmations.
|
|
58
58
|
<h5>Import</h5>
|
59
59
|
|
60
60
|
```typescript
|
61
|
-
import { AlertDialog } from '@symply.io/
|
61
|
+
import { AlertDialog } from '@symply.io/basic-components/';
|
62
62
|
// or
|
63
|
-
import AlertDialog from '@symply.io/
|
63
|
+
import AlertDialog from '@symply.io/basic-components/AlertDialog';
|
64
64
|
```
|
65
65
|
|
66
66
|
<h5>Props</h5>
|
@@ -83,9 +83,9 @@ Reusable modal component.
|
|
83
83
|
<h5>Import</h5>
|
84
84
|
|
85
85
|
```typescript
|
86
|
-
import { BasicModal } from '@symply.io/
|
86
|
+
import { BasicModal } from '@symply.io/basic-components/';
|
87
87
|
// or
|
88
|
-
import BasicModal from '@symply.io/
|
88
|
+
import BasicModal from '@symply.io/basic-components/BasicModal';
|
89
89
|
```
|
90
90
|
|
91
91
|
<h5>Props</h5>
|
@@ -119,9 +119,9 @@ It is extended from `@mui/material/TextField`, so it includes all properties of
|
|
119
119
|
<h5>Import</h5>
|
120
120
|
|
121
121
|
```typescript
|
122
|
-
import { DigitInput } from '@symply.io/
|
122
|
+
import { DigitInput } from '@symply.io/basic-components/';
|
123
123
|
// or
|
124
|
-
import DigitInput from '@symply.io/
|
124
|
+
import DigitInput from '@symply.io/basic-components/DigitInput';
|
125
125
|
```
|
126
126
|
|
127
127
|
<h5>Props</h5>
|
@@ -144,9 +144,9 @@ Radio Group allow the user to select one option from a set.
|
|
144
144
|
<h5>Import</h5>
|
145
145
|
|
146
146
|
```typescript
|
147
|
-
import { FormRadioGroup } from '@symply.io/
|
147
|
+
import { FormRadioGroup } from '@symply.io/basic-components/';
|
148
148
|
// or
|
149
|
-
import FormRadioGroup from '@symply.io/
|
149
|
+
import FormRadioGroup from '@symply.io/basic-components/FormRadioGroup';
|
150
150
|
```
|
151
151
|
|
152
152
|
<h5>Radio Option Props</h5>
|
@@ -179,9 +179,9 @@ Selector components are used for collecting user provided information from a lis
|
|
179
179
|
|
180
180
|
```typescript
|
181
181
|
// Simple Selector
|
182
|
-
import { SimpleSelector } from '@symply.io/
|
182
|
+
import { SimpleSelector } from '@symply.io/basic-components/FormSelector';
|
183
183
|
// Multiple Selector
|
184
|
-
import { MultipleSelector } from '@symply.io/
|
184
|
+
import { MultipleSelector } from '@symply.io/basic-components/FormRadioGroup';
|
185
185
|
```
|
186
186
|
|
187
187
|
<h5>Selector Option Props</h5>
|
@@ -230,9 +230,9 @@ You can use it to add a hint/help paragraph.
|
|
230
230
|
<h5>Import</h5>
|
231
231
|
|
232
232
|
```typescript
|
233
|
-
import { HelpCaption } from '@symply.io/
|
233
|
+
import { HelpCaption } from '@symply.io/basic-components/';
|
234
234
|
// or
|
235
|
-
import HelpCaption from '@symply.io/
|
235
|
+
import HelpCaption from '@symply.io/basic-components/HelpCaption';
|
236
236
|
```
|
237
237
|
|
238
238
|
<h5>Props</h5>
|
@@ -254,9 +254,9 @@ A modal for loading.
|
|
254
254
|
<h5>Import</h5>
|
255
255
|
|
256
256
|
```typescript
|
257
|
-
import { LoadingModal } from '@symply.io/
|
257
|
+
import { LoadingModal } from '@symply.io/basic-components/';
|
258
258
|
// or
|
259
|
-
import LoadingModal from '@symply.io/
|
259
|
+
import LoadingModal from '@symply.io/basic-components/LoadingModal';
|
260
260
|
```
|
261
261
|
|
262
262
|
<h5>Props</h5>
|
@@ -278,9 +278,9 @@ A button with menu options.
|
|
278
278
|
<h5>Import</h5>
|
279
279
|
|
280
280
|
```typescript
|
281
|
-
import { MenuButtonGroup } from '@symply.io/
|
281
|
+
import { MenuButtonGroup } from '@symply.io/basic-components/';
|
282
282
|
// or
|
283
|
-
import MenuButtonGroup from '@symply.io/
|
283
|
+
import MenuButtonGroup from '@symply.io/basic-components/MenuButtonGroup';
|
284
284
|
```
|
285
285
|
|
286
286
|
<h5>Menu Button Props</h5>
|
@@ -315,9 +315,9 @@ It is extended from `@mui/material/TextField`, so it includes all properties of
|
|
315
315
|
<h5>Import</h5>
|
316
316
|
|
317
317
|
```typescript
|
318
|
-
import { NumberInput } from '@symply.io/
|
318
|
+
import { NumberInput } from '@symply.io/basic-components/';
|
319
319
|
// or
|
320
|
-
import NumberInput from '@symply.io/
|
320
|
+
import NumberInput from '@symply.io/basic-components/NumberInput';
|
321
321
|
```
|
322
322
|
|
323
323
|
<h5>Props</h5>
|
@@ -343,9 +343,9 @@ It is extended from `@mui/material/TextField`, so it includes all properties of
|
|
343
343
|
|
344
344
|
```typescript
|
345
345
|
// Password
|
346
|
-
import { Password } from '@symply.io/
|
346
|
+
import { Password } from '@symply.io/basic-components/PasswordInput';
|
347
347
|
// Confirm Password
|
348
|
-
import { ConfirmPassword } from '@symply.io/
|
348
|
+
import { ConfirmPassword } from '@symply.io/basic-components/PasswordInput';
|
349
349
|
```
|
350
350
|
|
351
351
|
<h5>Password Props</h5>
|
@@ -377,9 +377,9 @@ It is extended from `@mui/material/TextField`, so it includes all properties of
|
|
377
377
|
<h5>Import</h5>
|
378
378
|
|
379
379
|
```typescript
|
380
|
-
import { PhoneNumberInput } from '@symply.io/
|
380
|
+
import { PhoneNumberInput } from '@symply.io/basic-components/';
|
381
381
|
// or
|
382
|
-
import PhoneNumberInput from '@symply.io/
|
382
|
+
import PhoneNumberInput from '@symply.io/basic-components/PhoneNumberInput';
|
383
383
|
```
|
384
384
|
|
385
385
|
<h5>Props</h5>
|
@@ -399,9 +399,9 @@ Tabs group.
|
|
399
399
|
<h5>Import</h5>
|
400
400
|
|
401
401
|
```typescript
|
402
|
-
import { TabGroup } from '@symply.io/
|
402
|
+
import { TabGroup } from '@symply.io/basic-components/';
|
403
403
|
// or
|
404
|
-
import TabGroup from '@symply.io/
|
404
|
+
import TabGroup from '@symply.io/basic-components/TabGroup';
|
405
405
|
```
|
406
406
|
|
407
407
|
<h5>Props</h5>
|
@@ -425,9 +425,9 @@ It is extended from `@mui/material/TextField`, so it includes all properties of
|
|
425
425
|
<h5>Import</h5>
|
426
426
|
|
427
427
|
```typescript
|
428
|
-
import { TextInput } from '@symply.io/
|
428
|
+
import { TextInput } from '@symply.io/basic-components/';
|
429
429
|
// or
|
430
|
-
import TextInput from '@symply.io/
|
430
|
+
import TextInput from '@symply.io/basic-components/TextInput';
|
431
431
|
```
|
432
432
|
|
433
433
|
<h5>Props</h5>
|
@@ -449,7 +449,7 @@ Global prompt component.
|
|
449
449
|
<h5>Import</h5>
|
450
450
|
|
451
451
|
```typescript
|
452
|
-
import { usePrompt } from '@symply.io/
|
452
|
+
import { usePrompt } from '@symply.io/basic-components';
|
453
453
|
```
|
454
454
|
|
455
455
|
<h5>Usage</h5>
|
@@ -474,9 +474,9 @@ A modal for playing videos.
|
|
474
474
|
<h5>Import</h5>
|
475
475
|
|
476
476
|
```typescript
|
477
|
-
import { VideoPlayerModal } from '@symply.io/
|
477
|
+
import { VideoPlayerModal } from '@symply.io/basic-components/';
|
478
478
|
// or
|
479
|
-
import VideoPlayerModal from '@symply.io/
|
479
|
+
import VideoPlayerModal from '@symply.io/basic-components/VideoPlayerModal';
|
480
480
|
```
|
481
481
|
|
482
482
|
<h5>Props</h5>
|