# gdp-ui-stencil

> Minimal starter for building a GDP widget/application using StencilJS.

Latest version **1.1.0** (published 2022-09-02) · SEE LICENSE IN LICENSE.md license · 0 weekly downloads

## Install

```sh
npm install gdp-ui-stencil
pnpm add gdp-ui-stencil
yarn add gdp-ui-stencil
bun add gdp-ui-stencil
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2022-09-02 |
| First published | 2022-09-02 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE.md |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Unpacked size | 442.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | vidyasharvin |

## Links

- npm: https://www.npmjs.com/package/gdp-ui-stencil
- Repository: https://git.prz.ics.eu-west-1.aws.thales/projects/GDP/repos/gdp-ui-stencil-starter
- npm.io page: https://npm.io/package/gdp-ui-stencil

## Dependencies (8)

- [axios](https://npm.io/package/axios.md) ^0.27.2
- [html2pdf.js](https://npm.io/package/html2pdf.js.md) ^0.9.0
- [gdp-ui-commons](https://npm.io/package/gdp-ui-commons.md) 11.27.1
- [gdp-ui-elements](https://npm.io/package/gdp-ui-elements.md) 13.27.27
- [smart-webcomponents](https://npm.io/package/smart-webcomponents.md) ^14.2.40
- [stenciljs-bootstrap](https://npm.io/package/stenciljs-bootstrap.md) 0.0.28-dev
- [@webcomponents/html-imports](https://npm.io/package/@webcomponents/html-imports.md) 1.2.6
- [@smarthtmlelements/smart-core](https://npm.io/package/@smarthtmlelements/smart-core.md) ^4.5.0

## Recent versions

- 1.1.0 (latest) — 2022-09-02

## README

# GDP UI Toolkit Starter (Stencil)

This repository provides a simple boilerplate for builing Web Components with [Stencil](https://github.com/ionic-team/stencil) to be used within the GDP environment.

This starter has:

- A Stencil Web Component example
- A sample GDP environment
- Unit and End-to-End (e2e) testing/coverage tools\*
- Development, build and linting configurations
- Automatic docs generation
- Integration with [Storybook](https://storybook.js.org/)

(\*) For unit (spec) tests only. [More info...](https://github.com/ionic-team/stencil/issues/1191)

## Getting started

To start a new project, clone this repo to a new directory and run:

```bash
npm install
```

then run:

```bash
npm start
```

To build the app for production, run:

```bash
npm run build
```

To run the unit tests once, run:

```
npm test
```

To run the unit tests and watch for file changes during development, run:

```
npm run test.watch
```

## Project structure

Inside the `src` folder you'll find the following:

### Directories

- `components`

  The source code for your component(s). Each component you create should follow the same file structure as the sample `gdp-ui-component`.

- `data`

  A folder containing any necessary data for testing your components. It comes with an example config file `settings.json`, which represents the sample `gdp-ui-component` as an available widget.

- `global`

  Where the global styles and scripts are stored. Please refer to the official Stencil docs on [the global files](https://Stencil.com/docs/config#globalscript).

### Files

- `components.d.ts`

  An automatically generated typings declaration file. You should never edit this file.

- `index.html`
- `index.ts`

  Sample index files. These are meant for testing your component(s) integration within a GDP application during development.

---
_Source: https://npm.io/package/gdp-ui-stencil · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._