Skip to content

Commit

Permalink
Clean up Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
csandman committed Jan 14, 2025
1 parent 6cf5081 commit 9f4fd90
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

This component is a wrapper for the popular react component
[React Select](https://react-select.com/home) made using the UI library
[Chakra UI](https://v2.chakra-ui.com/).
[Chakra UI](https://www.chakra-ui.com/).

> [!IMPORTANT]
>
Expand All @@ -29,8 +29,8 @@ This component is a wrapper for the popular react component
[![](https://img.shields.io/npm/v/chakra-react-select "chakra-react-select npm")](https://www.npmjs.com/package/chakra-react-select)
[![](https://badgen.net/bundlephobia/min/chakra-react-select "Minified Bundle Size")](https://bundlephobia.com/result?p=chakra-react-select)
[![](https://badgen.net/bundlephobia/minzip/chakra-react-select "Minzipped Bundle Size")](https://bundlephobia.com/result?p=chakra-react-select)
[![](https://badgen.net/npm/dt/chakra-react-select?color=blue&icon=npm "Total NPM Downloads")](https://npm-stat.com/charts.html?package=chakra-react-select&from=2021-09-13)
[![](https://badgen.net/npm/dw/chakra-react-select?color=blue&icon=npm "Weekly NPM Downloads")](https://npm-stat.com/charts.html?package=chakra-react-select&from=2021-09-13)
[![](https://img.shields.io/npm/dy/chakra-react-select?logo=npm&color=blue "NPM Downloads Per Year")](https://npm-stat.com/charts.html?package=chakra-react-select&from=2021-09-13)
[![](https://img.shields.io/npm/dw/chakra-react-select?logo=npm&color=blue "Weekly NPM Downloads")](https://npm-stat.com/charts.html?package=chakra-react-select&from=2021-09-13)
[![](https://snyk.io/test/github/csandman/chakra-react-select/badge.svg "Known Vulnerabilities")](https://snyk.io/test/github/csandman/chakra-react-select)
[![](https://img.shields.io/badge/Code_Style-prettier-c596c7.svg?logo=prettier "Code Style: Prettier")](https://github.com/prettier/prettier)
[![](https://badgen.net/github/license/csandman/chakra-react-select "MIT License")](LICENSE.md)
Expand Down Expand Up @@ -685,10 +685,6 @@ describing how it works:
> [styled components](https://www.styled-components.com/),
> [CSS modules](https://github.com/css-modules/css-modules) and other libraries.
Here is an example of using classNames to style the components:
[![SB-TS]](https://stackblitz.com/edit/vitejs-vite-zupcmm?file=src%2Fapp.tsx,src%2Fstyles.css)
## TypeScript Support
This package has always supported typescript, however until `v3.0.0` none of the
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ declare module "react-select/base" {
> {
/**
* The size of the base control; matches the sizes of the chakra Input
* component with the exception of `xs`. A [responsive style array/object](https://v2.chakra-ui.com/docs/features/responsive-styles) can
* component with the exception of `xs`. A [responsive style array/object](https://www.chakra-ui.com/docs/styling/responsive-design) can
* also be passed.
*
* Options: `sm` | `md` | `lg`
Expand Down

0 comments on commit 9f4fd90

Please sign in to comment.