Skip to content

Commit c0ae05b

Browse files
committed
Add stylized alerts instead of block quotes with "NOTE"
1 parent 4efd9c2 commit c0ae05b

File tree

1 file changed

+38
-25
lines changed

1 file changed

+38
-25
lines changed

README.md

Lines changed: 38 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@
1010

1111
# chakra-react-select v5
1212

13+
This component is a wrapper for the popular react component
14+
[React Select](https://react-select.com/home) made using the UI library
15+
[Chakra UI](https://v2.chakra-ui.com/).
16+
17+
> [!IMPORTANT]
18+
>
1319
> This version of `chakra-react-select` is updated for
1420
> [Chakra UI v2](https://v2.chakra-ui.com/getting-started/migration) which works
1521
> exclusively with React v18. `chakra-react-select` v3, which is compatible with
@@ -31,10 +37,6 @@
3137
[![](https://img.shields.io/badge/Code_Style-prettier-c596c7.svg?logo=prettier "Code Style: Prettier")](https://github.com/prettier/prettier)
3238
[![](https://badgen.net/github/license/csandman/chakra-react-select "MIT License")](LICENSE.md)
3339

34-
This component is a wrapper for the popular react component
35-
[react-select](https://react-select.com/home) made using the UI library
36-
[Chakra UI](https://v2.chakra-ui.com/).
37-
3840
| Light Mode | Dark Mode |
3941
| :-------------------------------------------------: | :-----------------------------------------------: |
4042
| ![Light Mode Demo](./.github/images/demo-light.png) | ![Dark Mode Demo](./.github/images/demo-dark.png) |
@@ -43,11 +45,13 @@ Check out the demo here:
4345

4446
[![SB-TS]](https://stackblitz.com/edit/vitejs-vite-lzaqwr?file=src%2Fapp.tsx)
4547

46-
**NOTE:** Before leaving an issue on this project, remember that this is just a
47-
_wrapper_ for `react-select`, not a standalone package. A large percentage of
48-
the questions people have end up being about how `react-select` itself works, so
49-
please read through their documentation to familiarize yourself with it!
50-
https://react-select.com/home
48+
> [!NOTE]
49+
>
50+
> Before leaving an issue on this project, remember that this is just a
51+
> _wrapper_ for `react-select`, not a standalone package. A large percentage of
52+
> the questions people have end up being about how `react-select` itself works,
53+
> so please read through their documentation to familiarize yourself with it!
54+
> https://react-select.com/home
5155
5256
## Contents
5357

@@ -94,11 +98,13 @@ npm i @chakra-ui/react @emotion/react@^11.8.1 @emotion/styled@^11 framer-motion@
9498
yarn add @chakra-ui/react @emotion/react@^11.8.1 @emotion/styled@^11 framer-motion@^6
9599
```
96100

97-
**NOTE:** As of
98-
[`v3.3.3`](https://github.com/csandman/chakra-react-select/releases/tag/v3.3.3),
99-
your project will need to have a minimum of `@emotion/react@11.8.1` installed to
100-
avoid having multiple copies of `@emotion/react` installed. For more info, see
101-
[PR #115](https://github.com/csandman/chakra-react-select/pull/115).
101+
> [!NOTE]
102+
>
103+
> As of
104+
> [`v3.3.3`](https://github.com/csandman/chakra-react-select/releases/tag/v3.3.3),
105+
> your project will need to have a minimum of `@emotion/react@11.8.1` installed
106+
> to avoid having multiple copies of `@emotion/react` installed. For more info,
107+
> see [PR #115](https://github.com/csandman/chakra-react-select/pull/115).
102108
103109
After Chakra UI is set up,
104110
[install this package from NPM](https://www.npmjs.com/package/chakra-react-select):
@@ -683,8 +689,10 @@ or are themselves those components. As this package pulls directly from your
683689
Chakra theme, any changes you make to those components' themes will propagate to
684690
the components in this package.
685691

686-
> **NOTE:** Some of the theme styles are manually overridden when this package
687-
> implements them. This is necessary for implementing styles for
692+
> [!NOTE]
693+
>
694+
> Some of the theme styles are manually overridden when this package implements
695+
> them. This is necessary for implementing styles for
688696
> [`size`](#size--options-responsivevaluesm--md--lg--default-md) variants in
689697
> components that do not natively have them in Chakra's default theme. This
690698
> mostly concerns components that make up the `Menu`, but there are a few other
@@ -714,9 +722,11 @@ Here is a list of all components that will be affected by changes to your theme:
714722
In addition to specific component styles, any changes you make to your global
715723
color scheme will also be reflected in these custom components.
716724

717-
> **NOTE:** Only make changes to your global component themes if you want them
718-
> to appear in all instances of that component. Otherwise, just change the
719-
> individual components' styles using the `chakraStyles` prop.
725+
> [!NOTE]
726+
>
727+
> Only make changes to your global component themes if you want them to appear
728+
> in all instances of that component. Otherwise, just change the individual
729+
> components' styles using the `chakraStyles` prop.
720730
721731
### `className`
722732

@@ -1101,9 +1111,10 @@ const GooglePlacesAutocomplete = () => {
11011111
export default GooglePlacesAutocomplete;
11021112
```
11031113

1104-
> **NOTE:** An API key would be needed to create a CodeSandbox example for this
1105-
> so you will have to implement it in your own project if you'd like to test it
1106-
> out.
1114+
> [!NOTE]
1115+
>
1116+
> An API key would be needed to create a CodeSandbox example for this so you
1117+
> will have to implement it in your own project if you'd like to test it out.
11071118
11081119
## Usage with React Form Libraries
11091120

@@ -1133,7 +1144,9 @@ component or [`useController`](https://react-hook-form.com/api/usecontroller)
11331144
hook in order to keep the value(s) tracked in `react-hook-form`'s state. Here
11341145
are some examples using each:
11351146

1136-
> **NOTE:** These examples still need to be updated to the newest version of
1147+
> [!NOTE]
1148+
>
1149+
> These examples still need to be updated to the newest version of
11371150
> `chakra-react-select` at some point, but they should still give you a good
11381151
> idea of how to implement what you want.
11391152
@@ -1238,8 +1251,8 @@ issue using one of these templates:
12381251
### StackBlitz
12391252

12401253
Recently, CodeSandbox severely limited their free tier, so this project has
1241-
started to move away from it. Here are a couple StackBlitz templates you can use
1242-
as an alternative.
1254+
started to move away from it. Here are a couple
1255+
[StackBlitz](https://stackblitz.com/) templates you can use as an alternative.
12431256

12441257
- Vanilla JS Starter:
12451258
https://stackblitz.com/edit/vitejs-vite-fatlrb?file=src%2Fapp.jsx

0 commit comments

Comments
 (0)