Skip to content

Commit 769ab59

Browse files
committed
README updates
1 parent 9b6c78b commit 769ab59

File tree

2 files changed

+36
-10
lines changed

2 files changed

+36
-10
lines changed

.prettierrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"bracketSpacing": true,
44
"jsxBracketSameLine": false,
55
"printWidth": 80,
6-
"proseWrap": "preserve",
6+
"proseWrap": "always",
77
"semi": false,
88
"singleQuote": true,
99
"tabWidth": 2,

README.md

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,30 +11,56 @@ me (i.e. I cannot guarantee any level of support).
1111

1212
[Click here to view the docs](https://gargrave.github.io/react-simple-select)
1313

14+
## Why?
15+
16+
Why make this when other options like `react-select` already cover all of these
17+
options and more?
18+
19+
You're right, `react-select` is a crazy good component, and I am certainly not
20+
trying to compete with it (hence why I suggested you might be better off using
21+
it for production projects). But there are a few reasons I wanted to build this:
22+
23+
- It's a fun project, so why not?
24+
- There are a few "I would do this different" aspects of other libs that I
25+
wanted to try
26+
- Build with fewer (if any) external dependencies (aside from React,
27+
obviously)
28+
- Allow for more friendly and flexible custom styling of every aspect of the
29+
component
30+
- Build it to be testable--some of the other libraries are notoriously
31+
difficult to test properly
32+
1433
## Getting Started
1534

1635
- Install:
1736
- `yarn add @gargrave/react-simple-select`
1837
- Initialize the styles somewhere near the root of your project:
1938
- `@import '@gargrave/react-simple-select/dist/react-simple-select.css'`
20-
- Technically, you don't _have_ to import these styles, but this does
21-
apply the default styling to the component, which I think you will in
22-
most cases. (You can pass in custom styles to override the defaults if
23-
you wish.)
24-
- Use the `Select` component in your project! A _very_ rough example might
25-
look something like this. (Until I have better docs, you can take a look at my
39+
- Technically, you don't _have_ to import these styles, but this does apply
40+
the default styling to the component, which I think you will in most cases.
41+
(You can pass in custom styles to override the defaults if you wish.)
42+
- Use the `Select` component in your project! A _very_ rough example might look
43+
something like this. (Until I have better docs, you can take a look at my
2644
[demo project](https://github.com/gargrave/react-simple-select-demo/blob/master/src/demo/DemoTS.tsx))
2745

2846
## Todo
2947

30-
These are few items on my current road map, although I don't have any specific ETA:
48+
These are few items on my current road map, although I don't have any specific
49+
ETA:
3150

51+
- [ ] Async searching/loading (in progress)
52+
- [ ] Customizable styling (in progress)
53+
- [ ] Accessibility additions (e.g. better ARIA handling for current lists)
54+
- [ ] Custom option rendering (e.g. render options as components instead of just
55+
strings)
56+
- [ ] Add ability to specify `data-testid` attributes to all "testable" parts of
57+
the component
3258
- [ ] Groupable options
3359
- [ ] Editable options (i.e. type to add a new option)
3460
- [ ] Multi-select
35-
- [ ] Accessibility
3661

3762
## Docs
3863

39-
Right now (and for the foreseeable future), the docs are just my Styleguidist build.
64+
Right now (and for the foreseeable future), the docs are just my Styleguidist
65+
build.
4066
[Click here to view the docs](https://gargrave.github.io/react-simple-select).

0 commit comments

Comments
 (0)