Skip to content

Commit 4ba6aba

Browse files
feat: wrote doc
1 parent b72a1f3 commit 4ba6aba

File tree

1 file changed

+82
-0
lines changed

1 file changed

+82
-0
lines changed

README.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -487,6 +487,88 @@ Outlined card is touchable.
487487
![card](https://ik.imagekit.io/Computools/rn-material-components/elevated-card.png?updatedAt=1705074211931)
488488
</details>
489489
</details>
490+
<details><summary>Chips</summary>
491+
<br />
492+
<details><summary>Assist Chip</summary>
493+
<br />
494+
495+
**Properties**
496+
497+
| name | description | type | default |
498+
| ------ | ------ | ------ | ---- |
499+
| label | required | string | - |
500+
| elevated | - | boolean | false |
501+
| LeadingIcon | - | React.FC | - |
502+
| TrailingIcon | - | React.FC | - |
503+
| leadingIconType | COMMON, FAVICON or BRANDED | IconType | COMMON |
504+
| trailingIconType | COMMON, FAVICON or BRANDED | IconType | COMMON |
505+
| leadingIconProps | - | T | - |
506+
| trailingIconProps | - | T | - |
507+
| iconSize | - | number | 18 |
508+
| labelStyle | - | TextStyle | - |
509+
510+
![assist chips](https://ik.imagekit.io/Computools/rn-material-components/assist_chip.png?updatedAt=1734450064327)
511+
512+
</details>
513+
<details><summary>Filter Chip</summary>
514+
<br />
515+
516+
**Properties**
517+
518+
| name | description | type | default |
519+
| ------ | ------ | ------ | ---- |
520+
| label | required | string | - |
521+
| selected | - | boolean | false |
522+
| elevated | - | boolean | false |
523+
| loading | Provide loading to show circle activity indicator instead of leading icon on loading | boolean |false |
524+
| LeadingIcon | - | React.FC | - |
525+
| TrailingIcon | - | React.FC | - |
526+
| leadingIconProps | - | T | - |
527+
| trailingIconProps | - | T | - |
528+
| iconSize | - | number | 18 |
529+
| activityIndicatorSize | - | number | 38 |
530+
531+
![filter chips](https://ik.imagekit.io/Computools/rn-material-components/filter_chip.png?updatedAt=1734450064378)
532+
![filter chip loading state](https://ik.imagekit.io/Computools/rn-material-components/filter_chip_loading_state.gif?updatedAt=1734450161294)
533+
</details>
534+
<details><summary>Input Chip</summary>
535+
<br />
536+
537+
**Properties**
538+
539+
| name | description | type | default |
540+
| ------ | ------ | ------ | ---- |
541+
| label | required | string | - |
542+
| selected | - | boolean | false |
543+
| imageUrl | Provide a url to show leading image. | string | - |
544+
| LeadingIcon | - | React.FC | - |
545+
| TrailingIcon | - | React.FC | - |
546+
| leadingIconProps | - | T | - |
547+
| trailingIconProps | - | T | - |
548+
| iconSize | - | number | 18 |
549+
| hasDefaultTrailingIcon | - | boolean | true |
550+
551+
![input chips](https://ik.imagekit.io/Computools/rn-material-components/input_chip.png?updatedAt=1734450064308)
552+
553+
</details>
554+
<details><summary>Suggestion Chip</summary>
555+
<br />
556+
557+
**Properties**
558+
559+
| name | description | type | default |
560+
| ------ | ------ | ------ | ---- |
561+
| label | required | string | - |
562+
| selected | - | boolean | false |
563+
| elevated | - | boolean | false |
564+
| LeadingIcon | - | React.FC | - |
565+
| TrailingIcon | - | React.FC | - |
566+
| leadingIconProps | - | T | - |
567+
| trailingIconProps | - | T | - |
568+
569+
![suggestion chips](https://ik.imagekit.io/Computools/rn-material-components/suggestion_chip.png?updatedAt=1734450064429)
570+
</details>
571+
</details>
490572
<details><summary>Controls</summary>
491573
<br />
492574

0 commit comments

Comments
 (0)