0.1.0 • Published 5 years ago

zenchi-options-list v0.1.0

Weekly downloads
3
License
(ISC OR GPL-3.0)
Repository
github
Last release
5 years ago

ZenChi OptionsList

Description: ZenChi OptionsList is a simple dropdown list with a vertical ellipsis HTML entity for an icon

Version: 0.1.0
Author: Elijah Liedtke (Chimera.Zen)
Email: chimera.zen@gmail.com
Link: https://github.com/ChimeraZen/zenchi-options-list

Copyright: Copyright (c) 2018, Elijah Liedtke
License: https://www.gnu.org/licenses/gpl-3.0.en.html

Table of Contents

  1. Instructions
    1. Installation
    2. Updating
    3. Uninstall
  2. Components
    1. OptionsList
  3. ChangeLog

Instructions

The following has been provided to assist in installing, updating or removing the ZenChi (pronounced: zen-Kai) Apps. Questions, comments, suggestions and concerns are welcome and can be sent to chimera.zen@gmail.com.

I hope you enjoy this app!

 

Installation

  1. Navigate to your app directory and install the ZenChi OptionsList package using:
npm i zenchi-options-list
  1. Once installed, ZenChi components can be imported using this syntax and replacing component_name with the required component:
import { OptionsList } from 'zenchi-options-list'

 

Updating

  1. Navigate to your app directory and enter:
npm update zenchi-options-list

 

Uninstall

  1. Navigate to your app directory and enter:
npm uninstall zenchi-options-list

 

Components

OptionsList

The ZenChi OptionsList component is a simple ReactJS droplist .

This component can be initialized using import { OptionsList } from 'zenchi-options-list'

<OptionsList>
  <li>Option 1</li>
  <li>Option 2</li>
</OptionsList>

Parameters

NameTypeDefaultSyntaxDescription
idstringPassed as a prop, an id can be attached to the OptionsList
classNamestringPassed as a prop, additional classes can be attached to the OptionsList

 

ChangeLog

v0.1.0

  • Initial commit
  • Created dropdown feature