Installations
npm install ngx-widgets
Developer Guide
Typescript
No
Module System
CommonJS
Min. Node Version
8.3.0
Node Version
8.12.0
NPM Version
6.4.1
Score
54.5
Supply Chain
84.9
Quality
78.8
Maintenance
50
Vulnerability
93
License
Releases
Contributors
Unable to fetch Contributors
Languages
TypeScript (40.95%)
JavaScript (38.64%)
CSS (11.21%)
HTML (4.85%)
Shell (3.46%)
Ruby (0.89%)
Love this project? Help keep it running — sponsor us today! 🚀
Developer
fabric8-ui
Download Statistics
Total Downloads
132,763
Last Day
1
Last Week
12
Last Month
438
Last Year
2,896
GitHub Statistics
Apache-2.0 License
4 Stars
415 Commits
18 Forks
20 Watchers
2 Branches
27 Contributors
Updated on Jan 28, 2023
Bundle Size
2.55 kB
Minified
908.00 B
Minified + Gzipped
Package Meta Information
Latest Version
3.2.0
Package Id
ngx-widgets@3.2.0
Unpacked Size
777.61 kB
Size
197.56 kB
File Count
163
NPM Version
6.4.1
Node Version
8.12.0
Total Downloads
Cumulative downloads
Total Downloads
132,763
Last Day
0%
1
Compared to previous day
Last Week
-82.1%
12
Compared to previous week
Last Month
142%
438
Compared to previous month
Last Year
-12.2%
2,896
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
2
Dev Dependencies
127
ngx-widgets
A collection of Angular components and other useful things to be shared.
You can see how it is used in our application here.
The system we build is composed of several components existing in separate repos but sharing common components, directives, and pipes. These widgets were extracted to provide a shared set of services.
Getting started:
This library does not run on it's own. It must be imported.
npm install ngx-widgets
There are several services and a couple of models used by them available.
container-toggle
dialog
dropdown
editable
icon
infinitescroll
Building it
Install the dependencies:
npm install
If you need to update the dependencies you can reinstall:
npm run reinstall
Run the tests:
npm test
Run Stylelint checks
'gulp lint-less'
Library Build
Production
To build ngx-widgets as a npm library, use:
npm run build
Whilst the standalone build uses webpack the library build uses gulp.
The created library is located in dist
. You shouldn't ever publish the
build manually, instead you should let the CD pipeline do a semantic release.
Development
To build ngx-widgets as an npm library and embed it into a webapp such as fabric8-ui, you should:
- Run
npm run watch:library
in this directory. This will build ngx-widgets as a library and then set up a watch task to rebuild any ts, html and less files you change. - In the webapp into which you are embedding, run
npm link <path to ngx-widgets>/dist-watch --production
. This will create a symlink fromnode_modules/ngx-widgets
to thedist-watch
directory and install that symlinked node module into your webapp. - Run your webapp in development mode, making sure you have a watch on
node_modules/ngx-widgets
enabled. To do this using a typical Angular Webpack setup, such as the one based on Angular Class, just runnpm start
. You will have access to both JS sourcemaps and LESS sourcemaps if your webapp is properly setup.
Note that fabric8-ui
is setup to do reloading and sourcemaps automatically when you
run npm start
.
Continuous Delivery & Semantic Relases
In ngx-widgets we use the semantic-release plugin. That means that all you have to do is use the AngularJS Commit Message Conventions (documented below). Once the PR is merged, a new release will be automatically published to npmjs.com and a release tag created on github. The version will be updated following semantic versionning rules.
Commit Message Format
A commit message consists of a header, body and footer. The header has a type, scope and subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header is optional.
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
Revert
If the commit reverts a previous commit, it should begin with revert:
, followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>.
, where the hash is the SHA of the commit being reverted.
Type
If the prefix is feat
, fix
or perf
, it will always appear in the changelog.
Other prefixes are up to your discretion. Suggested prefixes are docs
, chore
, style
, refactor
, and test
for non-changelog related tasks.
Scope
The scope could be anything specifying place of the commit change. For example $location
,
$browser
, $compile
, $rootScope
, ngHref
, ngClick
, ngView
, etc...
Subject
The subject contains succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize first letter
- no dot (.) at the end
Body
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
Footer
The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.
Breaking Changes should start with the word BREAKING CHANGE:
with a space or two newlines. The rest of the commit message is then used for this.
A detailed explanation can be found in this document.
Based on https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit
Examples
Appears under "Features" header, pencil subheader:
feat(pencil): add 'graphiteWidth' option
Appears under "Bug Fixes" header, graphite subheader, with a link to issue #28:
fix(graphite): stop graphite breaking when width < 0.1
Closes #28
Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
perf(pencil): remove graphiteWidth option
BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reason.
The following commit and commit 667ecc1
do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
revert: feat(pencil): add 'graphiteWidth' option
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
Commitizen - craft valid commit messages
Commitizen helps you craft correct commit messages. Install it using npm install commitizen -g
. Then run git cz
rather than git commit
.
Validate-commit-msg - validate commit messages
The validate-commit-msg githook checks for invalid commit messages.

No vulnerabilities found.
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE.txt:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE.txt:0
Reason
Found 4/8 approved changesets -- score normalized to 5
Reason
project is archived
Details
- Warn: Repository is archived.
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: containerImage not pinned by hash: Dockerfile.builder:1: pin your Docker image by updating centos:7 to centos:7@sha256:be65f488b7764ad3638f236b7b515b3678369a5124c47b8d32916d6487418ea4
- Warn: npmCommand not pinned by hash: cico_setup.sh:32
- Info: 0 out of 1 containerImage dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 30 are checked with a SAST tool
Score
3.9
/10
Last Scanned on 2025-02-10
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn MoreOther packages similar to ngx-widgets
ngx-simple-widgets
**Simple Widgets** is an [**Angular**](https://angular.io) component library that offers a collection of components designed to maintain a harmonious and unified user experience. These components are meticulously crafted with a consistent theme, drawing i
@acaprojects/ngx-widgets
Demo/Documentation can be found [here](https://aca.im/docs/widgets/).
@ngx-widgets/flamelink
This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.2.13.
@ngx-material-dashboard/widgets
[](https://badge.fury.io/js/@ngx-material-dashboard%2Fwidgets) []