@symply.io/basic-components 1.0.0-alpha.18 → 1.0.0-alpha.19
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/CheckBox/types.d.ts +2 -2
- package/README.md +9 -4
- package/package.json +1 -1
package/CheckBox/types.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { CSSProperties } from "react";
|
|
1
|
+
import { CSSProperties, ReactNode } from "react";
|
|
2
2
|
import { CheckboxProps } from "@mui/material/Checkbox";
|
|
3
3
|
import { FormGroupProps } from "@mui/material/FormGroup";
|
|
4
4
|
export interface CheckBoxProps extends Omit<CheckboxProps, "onChange"> {
|
|
5
|
-
label: string;
|
|
5
|
+
label: string | ReactNode;
|
|
6
6
|
onChange: (val: boolean) => void;
|
|
7
7
|
primaryColor?: CSSProperties["color"];
|
|
8
8
|
secondaryColor?: CSSProperties["color"];
|
package/README.md
CHANGED
|
@@ -20,6 +20,7 @@
|
|
|
20
20
|
- [CheckBoxGroup](#checkboxgroup)
|
|
21
21
|
- [Copyright](#copyright)
|
|
22
22
|
- [DigitInput](#digitinput)
|
|
23
|
+
- [FeinInput](#feininput)
|
|
23
24
|
- [FormRadioGroup](#formradiogroup)
|
|
24
25
|
- [FormSelector](#formselector)
|
|
25
26
|
- [HelpCaption](#helpcaption)
|
|
@@ -226,14 +227,16 @@ It is extended from `@mui/material/Checkbox`, so it includes all properties of `
|
|
|
226
227
|
import { CheckBox } from '@symply.io/basic-components/';
|
|
227
228
|
// or
|
|
228
229
|
import { CheckBox } from '@symply.io/basic-components/CheckBox';
|
|
230
|
+
// or
|
|
231
|
+
import CheckBox from '@symply.io/basic-components/CheckBox/CheckBox';
|
|
229
232
|
```
|
|
230
233
|
|
|
231
234
|
<h5>Props</h5>
|
|
232
235
|
|
|
233
|
-
| Name | Type
|
|
234
|
-
| -------- |
|
|
235
|
-
| label | string | | true | The label of the checkbox. |
|
|
236
|
-
| onChange | func
|
|
236
|
+
| Name | Type | Default | Required | Description |
|
|
237
|
+
| -------- | ------------------- | ------- | -------- | ------------------------------------------------------------ |
|
|
238
|
+
| label | string \| ReactNode | | true | The label of the checkbox. |
|
|
239
|
+
| onChange | func | | true | Callback fired when the `checkbox` value is changed.<br />**Signature:**<br/>`function(value: boolean) => void`<br/>*value:* The value of the `checkbox` element. |
|
|
237
240
|
|
|
238
241
|
|
|
239
242
|
|
|
@@ -249,6 +252,8 @@ It is extended from `@mui/material/FormGroup`, so it includes all properties of
|
|
|
249
252
|
import { CheckBoxGroup } from '@symply.io/basic-components/';
|
|
250
253
|
// or
|
|
251
254
|
import { CheckBoxGroup } from '@symply.io/basic-components/CheckBox';
|
|
255
|
+
// or
|
|
256
|
+
import CheckBoxGroup from '@symply.io/basic-components/CheckBox/CheckBoxGroup';
|
|
252
257
|
```
|
|
253
258
|
|
|
254
259
|
<h5>Props</h5>
|