# qw-components-lib

> Create a reusable Qwik component library

Latest version **0.0.2** (published 2023-08-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install qw-components-lib
pnpm add qw-components-lib
yarn add qw-components-lib
bun add qw-components-lib
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2023-08-28 |
| First published | 2023-08-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=15.0.0 |
| Dependencies | 0 |
| Unpacked size | 570.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | javigonzmoya |
| Keywords | library, components, design system, ui, qwik |

## Links

- npm: https://www.npmjs.com/package/qw-components-lib
- Repository: https://github.com/javigonzmoya/qw-components-lib
- Issues: https://github.com/javigonzmoya/qw-components-lib/issues
- npm.io page: https://npm.io/package/qw-components-lib

## Alternatives

- [@progress/kendo-ooxml](https://npm.io/package/@progress/kendo-ooxml.md) — 152.1K weekly downloads
- [@progress/kendo-react-ripple](https://npm.io/package/@progress/kendo-react-ripple.md) — 8.0K weekly downloads
- [@progress/kendo-react-orgchart](https://npm.io/package/@progress/kendo-react-orgchart.md) — 4.3K weekly downloads
- [@praxisui/dynamic-fields](https://npm.io/package/@praxisui/dynamic-fields.md) — 2.4K weekly downloads
- [@progress/kendo-vue-listbox](https://npm.io/package/@progress/kendo-vue-listbox.md) — 932 weekly downloads

## Recent versions

- 0.0.2 (latest) — 2023-08-28
- 0.0.1 — 2023-08-20

## README

# QW-COMPONENTS-LIB

QW design system consists on a library of QWIK components that implements a common design for applications.

## QW-DESIGN-SYSTEM-LIB STACK ⚡️

- [Qwik Docs](https://qwik.builder.io/)
- [Discord](https://qwik.builder.io/chat)
- [Qwik on GitHub](https://github.com/BuilderIO/qwik)
- [@QwikDev](https://twitter.com/QwikDev)
- [@QwikDev](https://twitter.com/QwikDev)
- [Vite](https://vitejs.dev/)
- [Vitest](https://vitest.dev/)

---

## Usage

```bash
npm npm i qw-components-lib
```

In your poject page.tsx

```tsx
import { QwButton } from 'qw-components-lib';

<QwButton>My button</QwButton>;
```

# Collaborations

---

## Project Structure

Inside your project, you'll see the following directories and files:

```
├── public/
│   └── ...
└── src/
    ├── components/
    │   └── qw-button
    │        |── stories
    |        |   └── ..
    │        |── test
    |        |   └── ..
    |        |── qw-button.tsx
    |        |── qw-button.scss
    |        └── _hooks.scss
    └── index.ts
```

- `src/components`: Recommended directory for components.

- `src/components/[component-name]/stories`: Recommended directory for stories.

- `src/components/[component-name]/test`: Recommended directory for test.

- `index.ts`: The entry point of your component library, make sure all the public components are exported from this file.

## Download

```bash
git clone https://github.com/javigonzmoya/qw-components-lib.git
```

```bash
git checkout release-x-x-x
```

```bash
git checkout -b feat/example-...
```

```bash
yarn install
```

## Development

Development mode uses [Vite's development server](https://vitejs.dev/). For Qwik during development, the `dev` command will also server-side render (SSR) the output. The client-side development modules are loaded by the browser.

```
yarn dev
```

> Note: during dev mode, Vite will request many JS files, which does not represent a Qwik production build.

## Build

The production build should generate the production build of your component library in (./lib) and the typescript type definitions in (./lib-types).

```
yarn build
```

## Testing

Run the simple unit tests.

```
yarn test:unit
```

Run the ui enviroment unit tests.

```
yarn test:unit:ui
```

Run the coverage.

```
yarn test:coverage
```

## Storybook

The storybook should run.

```
yarn storybook
```

And start local server.

```
http://localhost:6006/
```

---
_Source: https://npm.io/package/qw-components-lib · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
