1.0.2 • Published 10 months ago

react-native-material-chips v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

react-native-material-chips

🔥Easily implement versatile and customizable chips inspired from material design🔥

Demo

Features

  • Supports chip types: default, filter, and input
  • Provides chip variants: solid, outlined, and disabled for diverse visual styles.
  • Easy customization for appearance and behavior

Installation

$ yarn add react-native-material-chips

Examples

Example of Chip

import React from 'react';
import {StyleSheet} from 'react-native';
import {Chip} from 'react-native-material-chips';

const App = () => {
  const onChipItemPress = () => {
    console.log('Item pressed!');
  };

  return (
    <>
        <Chip
            label="What's on your mind?"
            style={styles.chip}
            onPress={onChipItemPress}
        />
    </>
  );
};

export default App;

const styles = StyleSheet.create({
  chip: {
    alignSelf: 'flex-start',
  }
});

Example of Chips

import React, {useState} from 'react';
import {Chips} from 'react-native-material-chips';

const App = () => {
  const [items, setItems] = useState([
    {label: 'Football', value: '1'},
    {label: 'Cricket', value: '2'},
    {label: 'Tennis', value: '3'},
    {label: 'Table Tennis', value: '4'},
    {label: 'Basketball', value: '5'},
    {label: 'Swimming', value: '6'},
  ]);
  const [selectedValues, setSelectedValues] = useState(['1', '2']);

  return (
    <>
      <Text variant="subtitle" content="Filter" />
      <Chips
        type="filter"
        itemVariant="outlined"
        items={items}
        setItems={setItems}
        selectedValues={selectedValues}
        setSelectedValues={setSelectedValues}
      />
    </>
  );
};

export default App;

Note: For more examples, check out example repository.

Props

Here's a props table for both Chip and Chips components:

Chip Component

PropTypeDescription
variantChipItemVariant (Optional)Chip style variant: 'solid', 'outlined' or 'disabled'. Default is 'solid'.
labelstringThe text content of the chip.
onPress() => void (Optional)Callback function invoked when the chip is pressed.
leadingIcon() => React.ReactElement \| null (Optional)Custom function returning a React element for the leading icon.
trailingIcon() => React.ReactElement \| null (Optional)Custom function returning a React element for the trailing icon.
styleStyleProp<ViewStyle> (Optional)Custom style for the entire chip container.
labelStyleStyleProp<TextStyle> (Optional)Custom style for the chip label text.
leadingIconContainerStyleStyleProp<ViewStyle> (Optional)Custom style for the leading icon container.
trailingIconContainerStyleStyleProp<ViewStyle> (Optional)Custom style for the trailing icon container.

Chips Component

PropTypeDescription
containerStyleStyleProp<ViewStyle> (Optional)Custom style for the entire chips container.
itemContainerStyleStyleProp<ViewStyle> (Optional)Custom style for each chip item container.
itemLabelStyleStyleProp<TextStyle> (Optional)Custom style for the chip item label text.
itemLeadingIconContainerStyleStyleProp<ViewStyle> (Optional)Custom style for the leading icon container within each chip item.
itemTrailingIconContainerStyleStyleProp<ViewStyle> (Optional)Custom style for the trailing icon container within each chip item.
itemsChipItem[]An array of chip items.
setItemsReact.Dispatch<React.SetStateAction<ChipItem[]>>State setter function for updating chip items.
selectedValuesstring[] (Optional)An array of selected values (for Filter chips).
setSelectedValuesReact.Dispatch<React.SetStateAction<string[]>> (Optional)State setter function for updating selected values.
typeChipsType (Optional)Type of chips: 'default', 'filter', or 'input'. Default is 'default'.
itemVariantChipItemVariant (Optional)Variant for chip items: 'solid', 'outlined' or 'disabled'. Default is 'solid'.

License

react-native-material-chips is MIT licensed .