Security News
npm Updates Search Experience with New Objective Sorting Options
npm has a revamped search experience with new, more transparent sorting options—Relevance, Downloads, Dependents, and Publish Date.
@volvo-cars/ced-os-react-components
Advanced tools
Set of components for developing UIs in the onboarding and support apps
This a component library based on vcc-ui created to standardize the creation and articulation of support article data provided via an API in JSON. Meaning when the new API provides content in JSON, it will have a structure that maps to these components. That way the data from the backend will dictate the structure and not the actual components. Although all components can and should be used where suitable also in other contexts.
The components can be viewed in this Storybook
The component are organized based on the Atomic design principles by Brad Frost.
npm install
npm run dev
to run storybooknpm test
to run testsThe library is automatically published to Github packages and NPM when
a new tag in the format v.X.X.X
is pushed to Github.
The steps to publish are:
npm run build
npm version <major>.<minor>.<patch>
to bump versionThe library is published as an NPM package and also a Github package.
Run npm install @volvo-cars/ced-os-react-components
.
To be able to install the package from the Github registry some configuration and Github authentication is needed.
Add a file called .npmrc
to your project and paste the lines below into it to configure NPM to load @volvo-cars packages from the Github registry. The second line
references an environment variable on your machine: VCC_GITHUB_PACKAGES_TOKEN
.
@volvo-cars:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=${VCC_GITHUB_PACKAGES_TOKEN}
The value of VCC_GITHUB_PACKAGES_TOKEN should be a Github Personal Access token with at least "read:packages" permissions.
If you use the dotenv package in your project it's also possible to define the
variable in the .env
file. In which case you need to do dotenv npm install
The main entrypoint
// ...
import { JSONArticle } from '@volvo-cars/ced-os-react-components';
const Article = ({ articleId, content }) => {
return (
<View paddingTop={[3, 6]} paddingBottom={[3, 6]}>
<JSONArticle data-article-id={articleId} data={content} />
</View>
);
};
If you want to use the renderer without creating a full JS project, with NPM etc, you can use the standalone solution. Include the standalone files under lib, and in the HTML template file, make sure to make the following replacements:
article: null
must be replaced with article: '<article>'
, where article
is the (JSON representation) of an article. It must contain an externalId
. It must also contain the content of the document, i.e. a title
and optionally also a description
and body
. These fields may be directly on the article
object itself, or nested inside of article.content
or article.jsonContent
.articleLinkClicked: null
may be replaced with articleLinkClicked: function(articleId, targetId) { ... }
, where the function will be called whenever the user clicks a link to another article. The function takes two arguments: the ID of the article being linked to, as well as (optionally) the ID of the target element (will typically just be null
). If articleLinkClicked
is left as null
, it will default to working as a normal link, such that if the current URL is foo/bar/articleId1
, and the user clicks a link to an article with ID articleId2
, it will navigate to foo/bar/articleId2
(or foo/bar/articleId2#targetId
, if targetId
is not null).linkClicked: null
may be replaced with linkClicked: function(href) { ... }
, where the function will be called whenever the user clicks on an external link. The function takes one argument: the URL of the link target. If linkClicked
is left as null, it will default to simply navigating to the link.FAQs
Set of components for developing UIs in the onboarding and support apps
The npm package @volvo-cars/ced-os-react-components receives a total of 867 weekly downloads. As such, @volvo-cars/ced-os-react-components popularity was classified as not popular.
We found that @volvo-cars/ced-os-react-components demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
npm has a revamped search experience with new, more transparent sorting options—Relevance, Downloads, Dependents, and Publish Date.
Security News
A supply chain attack has been detected in versions 1.95.6 and 1.95.7 of the popular @solana/web3.js library.
Research
Security News
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.