@uniformdev/context-ui
Advanced tools
React-based functionality and components for Uniform Context
Weekly downloads
Readme
.env.example
and rename to .env
, set up your project id, host, and API key.pnpm storybook
- run storybook app on http://localhost:9011/, is used for creating and editing components.Icon component can be is used only as a child of IconsProvider component.
pnpm build
- builds icons, JS modules, and CSS.This package uses Tailwind CSS. Run pnpm build:css
to compile the CSS file, which will run PostCSS with the Tailwind plugin against all .css
files in the assets
folder. The compiled CSS will be output to dist/assets/[filename].css
.
When Sanity Studio imports the JS modules exported by our plugin, the Sanity Studio bundler will also automatically import any CSS files that our code imports, e.g. import '../dist/assets/optimize.css';
NOTE: be sure to set NODE_ENV=production if you want PostCSS to purge unused CSS.
If you want to import SVG icons as components in your code, do the following:
src/assets
folderpnpm build:icons
This will generate React components for every SVG icon in the src/assets
folder. You can then import the icons in other React components, e.g. import MyIcon from '../assets/MyIcon';
.
Ideally, we could have import MyIcon from '../assets/my-icon.svg
in our code and the SVG icon would automatically be converted to a React component at build time and our source code would be transformed to import the component. However, we're not using a bundler so it becomes challenging because we can't "hook" into the TypeScript build/transpile process. We could introduce a build tool like ESBuild
or @babel/typescript
and stop using tsc
, but those options more tooling/overhead. We could also potentially use something like ttypescript
(https://github.com/cevek/ttypescript) to create babel-esque plugins for TypeScript, but who knows how reliable that is and if we'd run into any issues in CI/testing.
So, for now, icons are somewhat of a manual process.
No CommonJS modules are exported from this package as the package is intended to be consumed by Sanity Studio and not used during SSR.
FAQs
React-based functionality and components for Uniform Context
The npm package @uniformdev/context-ui receives a total of 1,309 weekly downloads. As such, @uniformdev/context-ui popularity was classified as popular.
We found that @uniformdev/context-ui demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 11 open source maintainers collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.