@vectara/vectara-ui
v3.1.0
Published
Vectara's design system, codified as a React and Sass component library
Downloads
10
Readme
Vectara UI
This is Vectara's design system, codified as a React component library. It's intended solely for consumption by Vectara and currently it isn't available for use by anybody else. For more information see NO_LICENSE.
Usage
Import components like this:
import { VuiFlexContainer, VuiItem } from "@vectara/vectara-ui";
Import our utils like this:
import { extractCitations } from "@vectara/vectara-ui/lib/utils/citations";
To import the CSS for the components, import this stylesheet at the root level:
import "@vectara/vectara-ui/lib/styles/index";
If you are using Sass and need Vectara UI's Sass variables, you can use this import in the files that use the variables:
@import "@vectara/vectara-ui/lib/sassUtils/index";
Publishing
Publishing a new version of the package consists of three steps:
- Maintaining the CHANGELOG.
- Versioning the package.
- Publishing to NPM.
Maintain the CHANGELOG
As you introduce changes, record them in the CHANGELOG beneath the main
section. Before you create a new version, submit a PR that updates the package.json
version and moves the main
content into a new section for the new version. We follow semver, so breaking changes should result in a major version bump.
Version the package
- Run
npm version {number}
to update package.json with the new version number and create a tag to track the version. - Run
git push origin --tags
to push the new tag to the repo. - Optional: Manually create a release in GitHub.
Publish to NPM
- Run
npm run buildPackage
to create the distributable files. - Run
npm login --scope=@vectara --registry="https://registry.npmjs.org/"
to log into the registry and scope. - Run
npm publish --access public
to publish the package to NPM.
Local development
Use npm run start
to run the docs site locally and interact with the code you're developing.
To test the package locally, use npm link
to consume the distributable files in a sibling project.
If you get an error regarding an "invalid hook call", you might need to use npm link
to temporarily link the consumer's React dependencies to Vectara-UI's React dependencies. In this example, we're consuming Vectara-UI in Vectara-Answer:
npm link ../vectara-answer/node_modules/react ../vectara-answer/node_modules/react-dom ../vectara-answer/node_modules/react-router-dom
When you're done testing out the consumer, you can unlink these dependencies:
npm unlink ../vectara-answer/node_modules/react ../vectara-answer/node_modules/react-dom ../vectara-answer/node_modules/react-router-dom
Licensing and public use
Though the GitHub terms of service grant anybody the right to fork and look through this repository, we haven't yet licensed this code for use by anybody else. This means Vectara reserves all rights to the contents of this repository. You can't reproduce, distribute, or create derivative works from it. For more information on reserved copyright of GitHub repos, see https://choosealicense.com/no-permission/.
For more information on our lack of licensing, see NO_LICENSE.