An open API service indexing awesome lists of open source software.

https://github.com/viclafouch/mui-color-input

📌 A color input designed for MUI (Material ui) built with TinyColor
https://github.com/viclafouch/mui-color-input

color-picker javascript material-ui mui mui6 reactjs typescript

Last synced: 24 days ago
JSON representation

📌 A color input designed for MUI (Material ui) built with TinyColor

Awesome Lists containing this project

README

        





Material UI color input


A color input designed for the React library Material UI



[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/viclafouch/mui-color-input/blob/master/LICENSE)
![ts](https://badgen.net/badge/Built%20With/TypeScript/blue)
[![npm](https://img.shields.io/npm/v/mui-color-input)](https://www.npmjs.com/package/mui-color-input)



## Installation

```
// with npm
npm install mui-color-input

// with yarn
yarn add mui-color-input
```

The component uses [@ctrl/tinycolor](https://www.npmjs.com/package/@ctrl/tinycolor) for color parsing and formatting.

## Usage

```jsx
import React from 'react'
import { MuiColorInput } from 'mui-color-input'

const MyComponent = () => {
const [value, setValue] = React.useState('#ffffff')

const handleChange = (newValue) => {
setValue(newValue)
}

return
}
```

## Next.js integration

Learn how to use MUI color input with Next.js

Once you have installed `MUI Color Input` in your next.js project, it is important to transpile it as it is an ESM package first.

```js
/** @type {import('next').NextConfig} */
const nextConfig = {
transpilePackages: ['mui-color-input'],
// your config
}

module.exports = nextConfig
```

## [Documentation](https://viclafouch.github.io/mui-color-input/)

## Changelog

Go to [GitHub Releases](https://github.com/viclafouch/mui-color-input/releases)

## TypeScript

This library comes with TypeScript "typings". If you happen to find any bugs in those, create an issue.

### 🐛 Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

### 💡 Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding
a 👍. This helps maintainers prioritize what to work on.

## LICENSE

MIT