# @paradigmjs/universal
> Paradigm Universal Rendering Utilities
Latest version **0.0.17** (published 2020-09-03) · MIT license · 0 weekly downloads
## Install
```sh
npm install @paradigmjs/universal
pnpm add @paradigmjs/universal
yarn add @paradigmjs/universal
bun add @paradigmjs/universal
```
## Health
**Score 30/100 (F)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities; high quality score.
Warnings: low downloads; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.0.17 |
| Published | 2020-09-03 |
| First published | 2020-07-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 55.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Sam Craig |
| Maintainers | lunaris-studios-admin |
## Links
- npm: https://www.npmjs.com/package/@paradigmjs/universal
- Repository: https://github.com/lunaris-studios/paradigm
- Homepage: https://github.com/lunaris-studios/paradigm#readme
- Issues: https://github.com/lunaris-studios/paradigm/issues
- npm.io page: https://npm.io/package/@paradigmjs/universal
## Dependencies (3)
- [@paradigmjs/util](https://npm.io/package/@paradigmjs/util.md) ^0.0.17
- [hoist-non-react-statics](https://npm.io/package/hoist-non-react-statics.md) ^3.3.2
- [@types/hoist-non-react-statics](https://npm.io/package/@types/hoist-non-react-statics.md) ^3.3.1
## Recent versions
- 0.0.17 (latest) — 2020-09-03
- 0.0.16 — 2020-08-30
- 0.0.15 — 2020-08-08
- 0.0.14 — 2020-08-07
- 0.0.13 — 2020-08-06
- 0.0.12 — 2020-08-01
- 0.0.11 — 2020-08-01
- 0.0.10 — 2020-08-01
- 0.0.9 — 2020-08-01
- 0.0.8 — 2020-08-01
- 0.0.7 — 2020-07-31
- 0.0.6 — 2020-07-29
- 0.0.5 — 2020-07-29
- 0.0.4 — 2020-07-29
- 0.0.3 — 2020-07-28
- … 1 more at https://npm.io/package/@paradigmjs/universal/versions
## README
🟦 Paradigm
Paradigm is a React-based UI toolkit for the web.
***Paradigm*** is optimized for building complex, data-dense web interfaces for _desktop applications_ which run in modern browsers and IE11. This is not a mobile-first UI toolkit.
[**View the full documentation ▸**](http://Paradigm.lunaris.io/docs)
[**Try it out on CodeSandbox ▸**](https://codesandbox.io/s/blueprint-sandbox-et9xy)
[**Read frequently asked questions (FAQ) on the wiki ▸**](https://github.com/lunaris-studios/Paradigm/wiki/Frequently-Asked-Questions)
## Changelog
Paradigm's change log and migration guides for major verions live on the repo's [Github wiki](https://github.com/lunaris-studios/Paradigm/wiki/1.x-Changelog).
## Packages
This repository contains multiple projects in the `packages/` directory that fall into 3 categories:
### Libraries
These are the component libraries we publish to NPM.
- [](https://www.npmjs.com/package/@paradigmjs/paradigm) - Core styles & components.
- [](https://www.npmjs.com/package/@paradigmjs/icons) - Components for generating and displaying icons.
- [](https://www.npmjs.com/package/@paradigmjs/nine) - Components to create dynamic [9-slice](https://en.wikipedia.org/wiki/9-slice_scaling) surfaces.
- [](https://www.npmjs.com/package/@paradigmjs/protocol) - Theme-aware responsive style props for building design systems.
### Applications
These are hosted on GitHub Pages as static web applications:
- `docs` - Documentation site at Paradigm.lunaris.io
### Build tooling
These packages define development dependencies and contain build configuration. They adhere to the standard NPM package layout, which allows us to keep clear API boundaries for build configuration and isolate groups of `devDependencies`. They are published to NPM in order to allow other related projects to use this infrastructure outside this monorepo.
- [](https://www.npmjs.com/package/@paradigmjs/scripts) - various utility scripts for linting, working with CSS variables, and building icons
## Contributing
Looking for places to contribute to the codebase?
First read the [contribution guidelines](https://github.com/lunaris-studios/Paradigm/blob/develop/CONTRIBUTING.md),
then [check out the "help wanted" label](https://github.com/lunaris-studios/Paradigm/labels/help%20wanted).
## Development
[Lerna](https://lerna.js.org/) manages inter-package dependencies in this monorepo.
Builds are orchestrated via `lerna run` and NPM scripts.
**Prerequisites**: Node.js v10+, NPM v6.13.4+
### One-time setup
After cloning this repo, run:
1. `npm i` to install all dependencies.
2. If running on Windows:
1. `npm install -g windows-build-tools` to install build tools globally
2. Ensure `bash` is your configured script-shell by running:
`npm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"`
### Incorporating upstream changes
If you were previously in a working state and have just pulled new code from `develop`:
- If there were package dependency changes, run `npm i` at the root.
- This command is very quick if there are no new things to install.
- Run `npm run compile` to get the latest built versions of the library packages in this repo.
- This command is quicker than `npm cache verify` since it doesn't build the application packages (`docs-app`, `landing-app`, etc.) or run tests
### Developing libraries
Run `npm run dev` from the root directory to watch changes across all packages and run the docs application with `rollup` dev server.
Alternately, each library has its own dev script to run the docs app and watch changes to just that package (and its dependencies): `npm run dev:core`, `npm run dev:nine`, etc.
### Updating documentation
Much of Paradigm's documentation lives inside source code as JSDoc comments in `.tsx` files. This documentation is extracted and converted automatically during the build of `packages/docs`.
If you are updating documentation sources you'll need to run `npm run compile` from `packages/docs` to see changes reflected in the application.
### Updating icons
The [One-time setup](#one-time-setup) and [Incorporating upstream changes](#incorporating-upstream-changes) steps should produce the generated source code in this repo used to build the icons documentation. This is sufficient for most development workflows.
If you are updating icons or adding new ones, you'll need to run `npm compile` in `packages/icons` to see those changes reflected before
running any of the dev scripts.
## License
This project is made available under the Apache 2.0 License.
---
_Source: https://npm.io/package/@paradigmjs/universal · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._