Chip React Component
Chips (Tags) React component represent complex entities in small blocks, such as a contact. They can contain a photo, short title string, and brief information
Chip Components
There are following components included:
Chip
Chip Properties
Prop | Type | Default | Description |
---|---|---|---|
<Chip> properties | |||
text | string | Chip label text | |
media | string | Text content of chip media | |
mediaBgColor | string | Chip media element background color. One of the default colors | |
mediaTextColor | string | Chip media element text color. One of the default colors | |
deleteable | boolean | false | Defines whether the Chip has additional "delete" button or not |
outline | boolean | false | Makes Chip outline |
tooltip | string | tooltip text to show on hover/press | |
tooltipTrigger | string | hover | Defines how to trigger (open) Tooltip. Can be hover , click or manual |
<Chip> icon related properties | |||
iconSize | string number | Icon size in px | |
iconColor | string | Icon color. One of the default colors | |
icon | string | Custom icon class | |
iconF7 | string | Name of F7 Icons font icon | |
iconMaterial | string | Name of Material Icons font icon | |
iconIos | string | Icon to be used in case of iOS theme is used. Consists of icon family and icon name divided by colon, e.g. f7:house | |
iconMd | string | Icon to be used in case of MD theme is used. Consists of icon family and icon name divided by colon, e.g. material:home | |
iconAurora | string | Icon to be used in case of Aurora theme is used. Consists of icon family and icon name divided by colon, e.g. material:home |
Chip Events
Event | Description |
---|---|
<Chip> events | |
click | Event will be triggered on Chip click |
delete | Event will be triggered on Chip delete button click |
Chip Slots
Chip React component has additional slots for custom elements:
text
- element will be inserted in place of chip text labeldefault
- (same astext
)media
- element will be inserted in the chip's media element
Examples
import React from 'react';
import { Page, Navbar, BlockTitle, Block, Chip, Icon, f7 } from 'framework7-react';
export default () => {
const deleteChip = (e) => {
const target = e.target;
f7.dialog.confirm('Do you want to delete this tiny demo Chip?', () => {
f7.$(target).parents('.chip').remove();
});
};
return (
<Page>
<Navbar title="Chips" />
<BlockTitle>Chips With Text</BlockTitle>
<Block strong>
<Chip text="Example Chip" />
<Chip text="Another Chip" />
<Chip text="One More Chip" />
<Chip text="Fourth Chip" />
<Chip text="Last One" />
</Block>
<BlockTitle>Outline Chips</BlockTitle>
<Block strong>
<Chip outline text="Example Chip" />
<Chip outline text="Another Chip" />
<Chip outline text="One More Chip" />
<Chip outline text="Fourth Chip" />
<Chip outline text="Last One" />
</Block>
<BlockTitle>Icon Chips</BlockTitle>
<Block strong>
<Chip text="Add Contact" mediaBgColor="blue">
<Icon
slot="media"
ios="f7:plus_circle"
aurora="f7:plus_circle"
md="material:add_circle"
/>
</Chip>
<Chip text="London" mediaBgColor="green">
<Icon slot="media" ios="f7:compass" aurora="f7:compass" md="material:location_on" />
</Chip>
<Chip text="John Doe" mediaBgColor="red">
<Icon slot="media" ios="f7:person" aurora="f7:person" md="material:person" />
</Chip>
</Block>
<BlockTitle>Contact Chips</BlockTitle>
<Block strong>
<Chip text="Jane Doe">
<img slot="media" src="https://cdn.framework7.io/placeholder/people-100x100-9.jpg" />
</Chip>
<Chip text="John Doe">
<img slot="media" src="https://cdn.framework7.io/placeholder/people-100x100-3.jpg" />
</Chip>
<Chip text="Adam Smith">
<img slot="media" src="https://cdn.framework7.io/placeholder/people-100x100-7.jpg" />
</Chip>
<Chip text="Jennifer" mediaBgColor="pink" media="J" />
<Chip text="Chris" mediaBgColor="yellow" mediaTextColor="black" media="C" />
<Chip text="Kate" mediaBgColor="red" media="K" />
</Block>
<BlockTitle>Deletable Chips / Tags</BlockTitle>
<Block strong>
<Chip text="Example Chip" deleteable onDelete={deleteChip} />
<Chip
text="Chris"
media="C"
mediaBgColor="orange"
textColor="black"
deleteable
onDelete={deleteChip}
/>
<Chip text="Jane Doe" deleteable onDelete={deleteChip}>
<img slot="media" src="https://cdn.framework7.io/placeholder/people-100x100-9.jpg" />
</Chip>
<Chip text="One More Chip" deleteable onDelete={deleteChip} />
<Chip text="Jennifer" mediaBgColor="pink" media="J" deleteable onDelete={deleteChip} />
<Chip text="Adam Smith" deleteable onDelete={deleteChip}>
<img slot="media" src="https://cdn.framework7.io/placeholder/people-100x100-7.jpg" />
</Chip>
</Block>
<BlockTitle>Color Chips</BlockTitle>
<Block strong>
<Chip text="Red Chip" color="red" />
<Chip text="Green Chip" color="green" />
<Chip text="Blue Chip" color="blue" />
<Chip text="Orange Chip" color="orange" />
<Chip text="Pink Chip" color="pink" />
<Chip outline text="Red Chip" color="red" />
<Chip outline text="Green Chip" color="green" />
<Chip outline text="Blue Chip" color="blue" />
<Chip outline text="Orange Chip" color="orange" />
<Chip outline text="Pink Chip" color="pink" />
</Block>
</Page>
);
};