0.3.2 • Published 3 years ago

@gargrave/velcrostrip v0.3.2

Weekly downloads
152
License
MIT
Repository
github
Last release
3 years ago

Velcrostrip

Velcrostrip is a general use React component library. The goal is for it to include most of the "general" stuff you would need in any typical frontend application (and then maybe a bunch of extra goodies, too).

You can see more or less everything in action in the Styleguide docs. This will be updated each time I release any version bump.

It is based on one of my favorite raw CSS libraries, Shoelace. I love Shoelace, but unfortunately its build/customization process in older versions aws a bit obtuse, so I decided I would take its inspiration and make a React version. The basic color schemes, designs, and components will generally be pretty similar, although I am not intending for it to be a 1:1 clone, and I may not include all of its components. We'll see...

For better or worse, I am also using Bootstrap 4 as inspiration in extending some components past what Shoelace provides (particularly with the ARIA stuff, which Bootstrap is very good at).

Other shout-outs:

Usage

The disclaimer:

  • I would not recommend using this in any production setting right now. This is mostly just a fun side project for me, and I make no guarantee as to how much time (if any) I will have to continue development, fix bugs, add new features, and all of that good stuff. As much as I enjoy it, my time is very limited, and side projects are the first thing to get pushed aside.
  • To expand on the point above, most of these steps are what should work, but I also don't have time for full regression testing when I do a release, so again: no guarantees here. YMMV, buyer beware, use at your own risk, and all of that good stuff.

  • Install
    • yarn add @gargrave/velcrostrip
  • Use
    • Everything is exported both top-level and directly. So you can import components two ways:
      • import { Button } from '@gargrave/velcrostrip, or
      • import { Button } from 'packages/velcrostrip/src/Button'
      • The difference of course is that the first will import the entire library as soon as you import a single component, and it might bloat your build a little bit.

At that point, you are ready to use the Button component. TypeScript types are included for all components, so you should get good completion for props and such, but you can also check out the styleguide with yarn styleguide, which will have examples covering almost everything.

This is a major work-in-progress, and will be for the foreseeable future. The components that are currently available are listed below.

  • Alert
  • Button
  • Card
  • Loader
0.3.2

3 years ago

0.3.0

3 years ago

0.3.1

3 years ago

0.2.1

3 years ago

0.2.0

4 years ago

0.1.4

4 years ago

0.1.3

4 years ago

0.1.2

4 years ago

0.1.1

4 years ago

0.1.0

4 years ago

0.0.6

4 years ago

0.0.5

4 years ago

0.0.1

4 years ago

0.0.2

4 years ago

0.0.0

4 years ago