evokit-list

EvoKit - List

Used to create list. Contains two elements <List> and <ListItem>

---

Install

Peer dependencies evokit. More about install

npm install evokit-list --save

Usage

More about usage. You can also use <List.Item> instead of <ListItem>

import React from 'react';
import { List, ListItem } from 'evokit-list';
import 'evokit-list/style.css';

const App = () => (
    <List list-indent='m'>
        <ListItem>
            ...
        </ListItem>
    </List>
);

Props

Also supports other valid props of the React Element. More about use props

<List />

Prop name	Default value	Possible value	Description
list-display	block	block none	Display type
list-color	null	Create theme	Marker color
list-divider	null	Create theme	Color separator between elements
list-indent	none	none xxs xs s m l xl xxl	Indentation between elements
list-style	null	dash decimal disc	Marker type
list-tag	ul	HTML tags	HTML tag

<ListItem />

Prop name	Default value	Possible value	Description
list-item-display	block	block none	Display type
list-item-tag	li	HTML tags	HTML tag

Customize

This set of css variables is default, if you want to override one or more value, please use the rules css-variable-usage, define them below the css import.

@custom-media --ek-list-media-small only screen and (min-width: 480px);
@custom-media --ek-list-media-medium only screen and (min-width: 768px);
@custom-media --ek-list-media-large only screen and (min-width: 960px);
@custom-media --ek-list-media-wide only screen and (min-width: 1200px);
@custom-media --ek-list-media-huge only screen and (min-width: 1400px);

:root {
    /* prop 'list-indent' */
    --ek-list-indent-xxs: 5px;
    --ek-list-indent-xs: 10px;
    --ek-list-indent-s: 15px;
    --ek-list-indent-m: 20px;
    --ek-list-indent-l: 25px;
    --ek-list-indent-xl: 30px;
    --ek-list-indent-xxl: 35px;
}

Live demo

---

list-tag

• Default value ul

<List list-tag='ul'>
    ...
</List>

list-display

• block - shown as blocky (default)
• none - remove block from document

<List list-display='none'>
    <ListItem>
        ...
    </ListItem>
</List>

list-indent

• none - no indent, value: 0px
• xxs - css variable --ek-list-indent-xxs, default value: 5px
• xs - css variable --ek-list-indent-xs, default value: 10px
• s - css variable --ek-list-indent-s, default value: 15px
• m - css variable --ek-list-indent-m, default value: 20px
• l - css variable --ek-list-indent-l, default value: 25px
• xl - css variable --ek-list-indent-xl, default value: 30px
• xxl - css variable --ek-list-indent-xxl, default value: 35px

<List list-indent='xxl'>
    <ListItem>
        ...
    </ListItem>
</List>

list-style

• dash - Dash marker (—)
• decimal - Arabic numbers (1, 2, 3, 4,...).
• disc - Dotted markerи (•)

<List list-style='decimal'>
    <ListItem>
        ...
    </ListItem>
</List>

list-color

Set the THEME_NAME depending on the theming

<List list-color={THEME_NAME}>
    <ListItem>
        ...
    </ListItem>
</List>

list-divider

Set the THEME_NAME depending on the theming

<List list-divider={THEME_NAME}>
    <ListItem>
        ...
    </ListItem>
</List>

list-item-tag

• Default value li

<List>
    <ListItem list-item-tag='li'>
        ...
    </ListItem>
</List>

list-item-display

• block - shown as blocky (default)
• none - remove block from document

<List>
    <ListItem list-item-display='none'>
        ...
    </ListItem>
</List>