![Introducing Enhanced Alert Actions and Triage Functionality](https://cdn.sanity.io/images/cgdhsj6q/production/fe71306d515f85de6139b46745ea7180362324f0-2530x946.png?w=800&fit=max&auto=format)
Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
@nearst/ui
Advanced tools
Readme
A universal UI framework for NearSt dashboard applications.
💻 NearSt UI Library on Storybook
To view this as a Storybook on your local machine, run yarn start
. This enables you to explore the existing components and see your code changes render (or not!) immediately. 😀
All files in src/index.js
will be part of the NPM package.
Complete components need to be imported into the src/index.js
(via their own component level index.js) and exported for bundling.
Any changes you make to the relevant *.stories.js
file will be visible through the Storybook running on your localhost.
For more information on developing with Storybook, view the docs here
It is possible to group related components in an expandable interface in order to help with Storybook organization. To do so, use the / as a separator:
// Checkbox.stories.js
export default {
title: 'Design System/Atoms/Checkbox'
}
More documentation here
Some general things to consider when creating new components:
index.js
in your component folder - this will be the point of entry for exporing the component(s) into the final npm module.CircleCI will automatically deploy Storybook to GitHub Pages when you merge your changes into master.
To do this manually run yarn deploy-storybook
You can find the deployed site here: https://near-live.github.io/NearData
📚Storybook deployerdocs
Run npm publish
to publish to npm.
💡 Make sure your UI Lib has an updated package.json version number which has been merged into Master alongside running this command.
If you want to test your branch code with a front-end property, publish the UI Library with a beta tag and make sure the version follows this format: "version": "0.10.10-beta.0"
To publish a beta version of the UI Library run npm publish --tag beta
When you are happy with your code and the PR has been approved.
"version": "0.10.10"
) and that this is part of your merge into Master.npm publish
to publish your branch to NPM.Make sure you have installed @nearst/ui from our mono repo modules.
yarn add @nearst/ui
You can then start using the NearSt UI module in your app by importing the individual components as demonstrated below.
import { Block, Drawer } from '@nearst/ui'
const app = () => (
<Block title={'A title for this block of info'}>
<Drawer title='Test app'>
<DrawerLink to='/' title='Dashboard' />
</Drawer>
</Block>
)
You will also need to import the UI Library CSS by adding the following to your top level file - usually the index.js or App.js
import '@nearst/ui/dist/ui.css';
You can access the colours from the UI library in your CSS files by using the following syntax
.kanban-text {
color: var(--dark-blue);
}
You just need to check the variable names in story book and add "--" beforhand. var(--color-name)
. Simples!
Please see the Notes
section of each component in Storybook for further information on implementation.
FAQs
UI framework for NearSt dashboard applications.
The npm package @nearst/ui receives a total of 167 weekly downloads. As such, @nearst/ui popularity was classified as not popular.
We found that @nearst/ui demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 9 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.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.