From 464e0b073b9457486407104db2c654b7810ea518 Mon Sep 17 00:00:00 2001 From: Chris Sandvik Date: Tue, 5 Jul 2022 13:12:56 -0400 Subject: [PATCH 1/2] Update all links for chakra v1 --- README.md | 24 +++++++++--------- src/module-augmentation.ts | 50 +++++++++++++++++++------------------- 2 files changed, 37 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 23ddaef..c09ca02 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # chakra-react-select v3 -> This version of `chakra-react-select` is for compatibility with React v17 and Chakra UI v1. It will be maintained until the majority of users have migrated to the newest version of Chakra. If you're using [Chakra UI v2](https://chakra-ui.com/guides/migration) check [the docs for chakra-react-select v4 here](https://github.com/csandman/chakra-react-select). +> This version of `chakra-react-select` is for compatibility with React v17 and Chakra UI v1. It will be maintained until the majority of users have migrated to the newest version of Chakra. If you're using [Chakra UI v2](https://chakra-ui.com/getting-started/migration) check [the docs for chakra-react-select v4 here](https://github.com/csandman/chakra-react-select). [![Build Status](https://github.com/csandman/chakra-react-select/actions/workflows/build.yml/badge.svg?branch=main "Build Status")](https://github.com/csandman/chakra-react-select/actions/workflows/build.yml?query=branch%3Amain) [![Lint Status](https://github.com/csandman/chakra-react-select/actions/workflows/lint.yml/badge.svg?branch=main "Lint Status")](https://github.com/csandman/chakra-react-select/actions/workflows/lint.yml?query=branch%3Amain) @@ -12,7 +12,7 @@ [![Code Style: Prettier](https://img.shields.io/badge/code_style-prettier-c596c7.svg "Code Style: Prettier")](https://github.com/prettier/prettier) [![MIT License](https://badgen.net/github/license/csandman/chakra-react-select "MIT License")](LICENSE.md) -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://chakra-ui.com/). +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://v1.chakra-ui.com/). ![Chakra React Select Banner](./github/chakra-react-select.png) @@ -97,7 +97,7 @@ In order to use this component, you can implement it and use it like you would n #### `size` — Options: `sm`, `md`, `lg` — Default: `md` -You can pass the `size` prop with either `sm`, `md`, or `lg` (default is `md`). These will reflect the sizes available on the [Chakra `` component](https://chakra-ui.com/docs/form/input#changing-the-size-of-the-input) (with the exception of `xs` because it's too small to work). +You can pass the `size` prop with either `sm`, `md`, or `lg` (default is `md`). These will reflect the sizes available on the [Chakra `` component](https://v1.chakra-ui.com/docs/form/input#changing-the-size-of-the-input) (with the exception of `xs` because it's too small to work). ```js return ( @@ -111,7 +111,7 @@ return ( #### `colorScheme` -You can pass the `colorScheme` prop to the select component to change all of the selected options tags' colors. You can view the whole list of available color schemes in [the Chakra docs](https://chakra-ui.com/docs/data-display/tag#props), or if you have a custom color palette, any of the custom color names in that will be available instead. +You can pass the `colorScheme` prop to the select component to change all of the selected options tags' colors. You can view the whole list of available color schemes in [the Chakra docs](https://v1.chakra-ui.com/docs/data-display/tag#props), or if you have a custom color palette, any of the custom color names in that will be available instead. Alternatively you can add the `colorScheme` key to any of your options objects and it will only style that option when selected. @@ -137,7 +137,7 @@ return ( #### `tagVariant` — Options: `subtle`, `solid`, `outline` — Default: `subtle` -You can pass the `tagVariant` prop with either `subtle`, `solid`, or `outline` (default is `subtle`). These will reflect the `variant` prop available on the [Chakra `` component](https://chakra-ui.com/docs/data-display/tag#props). +You can pass the `tagVariant` prop with either `subtle`, `solid`, or `outline` (default is `subtle`). These will reflect the `variant` prop available on the [Chakra `` component](https://v1.chakra-ui.com/docs/data-display/tag#props). Alternatively you can add the `variant` key to any of your options objects and it will only style that option when selected. This will override the `tagVariant` prop on the select if both are set @@ -187,7 +187,7 @@ return ( #### `focusBorderColor` — Default: `blue.500` | `errorBorderColor` — Default: `red.500` -The props `focusBorderColor` and `errorBorderColor` can be passed with Chakra color strings which will emulate the respective props being passed to [Chakra's `` component](https://chakra-ui.com/docs/form/input#changing-the-focus-and-error-border-colors). +The props `focusBorderColor` and `errorBorderColor` can be passed with Chakra color strings which will emulate the respective props being passed to [Chakra's `` component](https://v1.chakra-ui.com/docs/form/input#changing-the-focus-and-error-border-colors). ```js return ( @@ -216,7 +216,7 @@ return `](https://chakra-ui.com/docs/form/select) styles example: +- Default [Chakra `