https://github.com/abraham/node-package

Node Package Web Component
https://github.com/abraham/node-package

node-package npm web-components

Last synced: 21 days ago
JSON representation

Node Package Web Component

• Host: GitHub
• URL: https://github.com/abraham/node-package
• Owner: abraham
• License: mit
• Created: 2018-02-18T22:03:44.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-08-02T22:59:32.000Z (over 1 year ago)
• Last Synced: 2024-10-05T08:01:14.082Z (about 1 month ago)
• Topics: node-package, npm, web-components
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/node-package
• Size: 813 KB
• Stars: 21
• Watchers: 3
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
<node-package>

====

[![Version Status](https://img.shields.io/npm/v/node-package.svg?style=flat&label=version&colorB=4bc524)](https://npmjs.com/package/node-package)

[![macOS Build Status](https://img.shields.io/circleci/project/github/abraham/node-package.svg?style=flat&label=macos)](https://circleci.com/gh/abraham/node-package)

[![Linux Build Status](https://img.shields.io/travis/abraham/node-package.svg?style=flat&label=linux)](https://travis-ci.org/abraham/node-package)

[![Windows Build Status](https://img.shields.io/appveyor/ci/abraham/node-package.svg?style=flat&label=windows)](https://ci.appveyor.com/project/abraham/node-package)

[![Dependency Status](https://david-dm.org/abraham/node-package.svg?style=flat)](https://david-dm.org/abraham/node-package)

[![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/node-package.svg?style=flat&colorB=4bc524)](https://bundlephobia.com/result?p=node-package)

Install

----

Polyfill tags if you need them. This will include ShadowDOM and Custom Elements support.

```

```

Loading this component. It would be a good idea to use a specific version instead of `latest`.

```

```

Example

----

[Live demo](https://codepen.io/abraham/pen/eVVJrM)

Usage

----

Set the `name` attribute to the name of an [NPM](https://www.npmjs.com/) package.

```

```

![Example](https://github.com/abraham/node-package/raw/master/images/default.png)

Add the `global` attribute to add `--global` to the NPM install command.

```

```

Will result in `npm install @angular/cli --global`.

Theming

----

For advanced theming you can set the following CSS custom properties:

- `--node-package-background-color`

- `--node-package-color`

- `--node-package-link-color`

Blue theme

```

  node-package.blue {

    --node-package-background-color: #03A9F4;

    --node-package-color: #FAFAFA;

    --node-package-link-color: #dadce0;

  }

```

![Example with blue theme](https://github.com/abraham/node-package/raw/master/images/custom-theme-blue.png)

Red theme

```

  node-package.red {

    --node-package-background-color: #CB3837;

    --node-package-color: #FAFAFA;

    --node-package-link-color: #dadce0;

  }

```

![Example with red theme](https://github.com/abraham/node-package/raw/master/images/custom-theme-red.png)

Card border

You can also apply custom edge designs to look more like a card.

```

  node-package.card {

    box-shadow: 0 3px 4px 1px rgba(0, 0, 0, .08), 0 1px 1px 1px rgba(0, 0, 0, .05);

    border-radius: 2px;

    border-width: 0;

  }

```

![Example with card border](https://github.com/abraham/node-package/raw/master/images/card.png)

Demo of install commands being copied.

![Example of copying install command](https://github.com/abraham/node-package/raw/master/images/copy-install.gif)

License

----

NodePackage is released under an MIT license.

Built, tested, and published with [Nutmeg](https://nutmeg.tools).