1.0.4 • Published 2 years ago

dk_select_package v1.0.4

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

#dk_select_package

dk_select_package is a customisable select input

###EXAMPLE OF A STYLIZED RENDERING

Select

Installation

npm i dk_select_package

Usage

This package is made for use in a react application like a registration form for example

Example

In a SignUp component

In this example we want to see the name of the state selected but also the abbreviation of this state for db traitements, we will import an array of just 3 states containing a name and an abbreviation :

Array of states

export const states = [
  {
    name: "Alabama",
    abbreviation: "AL",
  },
  {
    name: "Alaska",
    abbreviation: "AK",
  },
  {
    name: "American Samoa",
    abbreviation: "AS",
  }
]

Package usage

//SignUp.jsx

import React, { useState } from "react"
import { SelectDk } from "dk_select_package" 
import {states} from './folder of states array'

const SignUp = () => {

  const [userName,setUserName] = useState("")
  const [password, setPassword] = useState("")
  const [selectIsOpen, setSelectIsOpen] = useState(false) // false if option close true if open
  const [stateName,setStateName] = useState('Alabama') // visible value in the select area (put a default value) change after choosen option
  const [stateAbb,setStateAbb] = useState('AL) // state abbreviation used in data base in this example
  const closeSelect = () => selectIsOpen && setStateOpen(false) // close the option container when click outside 

  // update the state stateString value (name in the object array of states) and the stateValue (abbreviation in the objects array of states)
  const updateState = (data) => {
    setStateAbb(data.value)
    setStateName(data.label)
  }

  //signUp function

  const signUp = () => {
    ...do something to sign up 
  }
   

  return (
    <form onSubmit = {signUp}>
      <label  htmlFor="userName">
        Username
      </label>
      <input
        type="text"
        name="userName"
        id="userName"
        value={userName}          
        onChange={(e) => setUserName(e.target.value.trim())}
        autoFocus
      />

      <label  htmlFor="password">
        Password
      </label>
      <input
        type="password"
        name="password"
        id="password"
        value={password}
        onChange={(e) => setPassword(e.target.value.trim())}
      />

      <SelectDk
         
          datas={states.map((el) => ({
              value: el.abbreviation,
              label: el.name, // !REQUIRE you must have a label parameter in your map object
            }))}
          update={updateState}
          visibleValue={stateName}
          open={selectIsOpen}
          setOpen={setSelectIsOpen}
      />

      <input className="submitBtn" type="submit" value="SignUp" />
    
    </form>
  )
}

Inline Style Package

You can change all the package style whith a css file but if you won't create css file you can use the inline style like this

 <SelectDk
            datas={states.map((el) => ({
              value: el.abbreviation,
              label: el.name,
            }))}
            update={updateState}
            visibleValue={stateName}
            open={selectIsOpen}
            setOpen={setSelectIsOpen}
            // for change the select input style
            listBoxStyle={{ color: "white", background: "red" }} 
            // for change the options container style
            optionsContainerStyle={{
              scrollbarColor: " darkBlue pink",
              backgroundColor: "white",
            }}
            // for change the options style (only backgroundColor and color)
            optionsStyle={{
              backgroundColor: "white",
              color: "orange",
            }}
            // for change the options style when they hover  (only backgroundColor and color)
            hoverOptionsStyle={{
              backgroundColor: "orange",
              color: "white",
            }}
 />
1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago