selectmenu-cmp
v0.0.30
Published
selectmenu package
Downloads
8
Readme
SelectMenu Component
The SelectMenu component is a React component that provides a customizable dropdown menu with search functionality. It allows users to select an option from a list of values and provides various customization options for appearance and behavior.
Prerequisites
To use the SelectMenu component in your React application, you need:
To have node Node : ^16.15.1
To have install tailwindcss : https://tailwindcss.com/docs/installation/framework-guides
Installation
To use the SelectMenu component in your React application, follow these steps:
Install the package:
npm install selectmenu-cmp
Your tailwin.config.js should be like this :
/** @type {import('tailwindcss').Config} */ export default { content: [ "./index.html", "./src/**/*.{js,ts,jsx,tsx}", './node_modules/selectmenu-cmp/**/*.{js,ts,jsx,tsx}', ], theme: { extend: {}, }, plugins: [], }
Import the SelectMenu component into your React application:
import SelectMenu from "selectmenu-cmp";
You can now use the
SelectMenu
component in your application.
Usage
You can find exemples in the folder src/examples
of this repository.
Here's an example of how to use the SelectMenu
component:
import React, { useState } from 'react';
import SelectMenu from "selectmenu-cmp";
function App() {
const [selectedValue, setSelectedValue] = useState('');
const values = [
{ name: 'Option 1' },
{ name: 'Option 2' },
{ name: 'Option 3' },
];
return (
<div>
<h1>SelectMenu Example</h1>
<SelectMenu
id="mySelectMenu"
values={values}
inputValue={selectedValue}
setter={setSelectedValue}
width={'350px'}
inputHeight={'45px'}
backgroundColor={"orange"}
textColor={"red"}
activeColor={"blue"}
inputTextColor={"orange"}
inputBackgroundColor={"#ffe9d3"}
iconColor={"orange"}
/>
</div>
);
}
export default App;
Props
The SelectMenu
component accepts the following props:
id
(string, required): A unique identifier for the component.values
(array of objects, required): An array of options to display in the dropdown.inputValue
(string, required): The currently selected value.setter
(function, required): A function to set the selected value.isError
(bool, required): Indicates whether there is an error in the component.width
(string): The width of the component (default: '100%').inputHeight
(string): The height of the input field (default: '45px').backgroundColor
(string): The background color of the component (default: 'transparent').textColor
(string): The text color of the component (default: 'black').inputBackgroundColor
(string): The background color of the input field (default: 'transparent').inputTextColor
(string): The text color of the input field (default: 'black').iconColor
(string): The color of the dropdown icon (default: 'black').activeColor
(string): The background color of the selected option (default: '#D0E7B9').
License
This component is open-source and available under the MIT License.