# ds-citeo

> CITEO's Design System Stencil Components

Latest version **1.3.0** (published 2023-03-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install ds-citeo
pnpm add ds-citeo
yarn add ds-citeo
bun add ds-citeo
```

## Health

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

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

Warnings: low downloads; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2023-03-29 |
| First published | 2021-09-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 14 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | design-system.citeo |

## Links

- npm: https://www.npmjs.com/package/ds-citeo
- npm.io page: https://npm.io/package/ds-citeo

## Dependencies (5)

- [prettier](https://npm.io/package/prettier.md) ^2.6.2
- [@stencil/core](https://npm.io/package/@stencil/core.md) ^2.10.1
- [@stencil/sass](https://npm.io/package/@stencil/sass.md) ^1.4.1
- [@stencil/react-output-target](https://npm.io/package/@stencil/react-output-target.md) ^0.1.0
- [@stencil/angular-output-target](https://npm.io/package/@stencil/angular-output-target.md) ^0.1.0

## Recent versions

- 1.3.0 (latest) — 2023-03-29
- 1.2.26 — 2023-02-14
- 1.2.26-rc14 — 2023-02-14
- 1.2.26-rc13 — 2023-02-14
- 1.2.26-rc12 — 2023-02-14
- 1.2.26-rc11 — 2023-02-14
- 1.2.26-rc10 — 2023-02-14
- 1.2.26-rc9 — 2023-02-14
- 1.2.26-rc8 — 2023-02-14
- 1.2.26-rc7 — 2023-02-14
- 1.2.25 — 2023-01-24
- 1.2.26-rc6 — 2023-01-19
- 1.2.26-rc5 — 2023-01-19
- 1.2.26-rc4 — 2023-01-19
- 1.2.26-rc3 — 2023-01-19
- … 55 more at https://npm.io/package/ds-citeo/versions

## README

![Citeo](https://dev-citeo.citeo.com/fr/assets/img/logo/logo-citeo.svg)

# Stencil Component Starter

This is a starter project for building a standalone Web Component using Stencil.

# Stencil

Stencil is a compiler for building fast web apps using Web Components.

Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.

Stencil components are just Web Components, so they work in any major framework or with no framework at all.

## Getting Started

To start building a new web component using Stencil, in this directory, run :

```bash
npm install
npm run start
```

You'll reach the main page of our Stencil application (on `localhost:3333` by default) and see all the components developed 🙂 !

To generate a new component, run :

```bash
npm run generate
```

A wizard will lead you while creating your new component allowing you to choose if you want to create style, spec and/or test files.

You can find your new component in `/src/components`.

To build the component for production, stop the server if it's running, remove `dist`, `loader` and `www` directories and run:

```bash
npm run build
```

To run the unit tests for the components, run:

```bash
npm test
```

Note: for re-use, we will use `Using this component`'s second method (via Node modules)

To publish your components, update the version in the `package.json` and log you in to npm :

```bash
npm login
```

and run :

```bash
npm publish
```

Need help? Check out our docs [here](https://stenciljs.com/docs/my-first-component).

## Naming Components

When creating new component tags, we recommend _not_ using `stencil` in the component name (ex: `<stencil-datepicker>`). This is because the generated component has little to nothing to do with Stencil; it's just a web component!

Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic generated web components use the prefix `ion`.

## Using this component

There are three strategies we recommend for using web components built with Stencil.

The first step for all three of these strategies is to [publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages).

### Script tag

- Put a script tag similar to this `<script src='https://unpkg.com/my-component@0.0.1/dist/my-component.esm.js'></script>` in the head of your index.html
- Then you can use the element anywhere in your template, JSX, html etc

### Node Modules

- Run `npm install my-component --save`
- Put a script tag similar to this `<script src='node_modules/my-component/dist/my-component.esm.js'></script>` in the head of your index.html
- Then you can use the element anywhere in your template, JSX, html etc

### In a stencil-starter app

- Run `npm install my-component --save`
- Add an import to the npm packages `import my-component;`
- Then you can use the element anywhere in your template, JSX, html etc

## Changelog

`v.1.3.0` _10 March 2023_

- Updating Button with Tokens/CSS Custom Properties combo

`v.1.2.31` _24 February 2023_

- Fixing and Harmonizing icons svg content

`v.1.2.30` _23 February 2023_

- Re-implementing Icon position Fix

`v.1.2.29` _22 February 2023_

- Adding some icons on Icon Component (Pack #6)

`v.1.2.28` _16 February 2023_

- Adding some icons on Icon Component (Pack #4)

`v.1.2.27` _16 February 2023_

- Adding some icons on Icon Component (Pack #3)

`v.1.2.26` _15 February 2023_

- Some Sidebar Fix
- Rolling-back Icon position Fix

`v.1.2.25` _24 January 2023_

- Fix icon display

`v.1.2.24` _10 January 2023_

- Fix info notification icon

`v.1.2.22` _26 October 2022_

- Adding eco-conception icon on Icon Component

`v.1.2.21` _04 October 2022_

- Adding key icon on Icon Component

`v.1.2.20` _22 September 2022_

- Adding save icon on Icon Component

`v.1.2.19` _21 September 2022_

- Adding Notification component and mark the Toast one as deprecated

`v.1.2.18` _14 September 2022_

- Adding unlock icon on Icon Component

`v.1.2.17` _12 September 2022_

- Adding the size (`small | medium`) attribute for the checkbox

`v.1.2.16` _08 September 2022_

- Adding some icons on Icon Component

`v.1.2.15` _01 August 2022_

- Adding some icons on Icon Component

`v.1.2.14` _27 July 2022_

- Sidebar Optimization

`v.1.2.13` _25 July 2022_

- Adding some icons on Icon Component

`v.1.2.12` _25 July 2022_

- [ O Success ] Sidebar Optimization (Build success)

`v.1.2.11` _25 July 2022_

- [ X Failed ] Sidebar Optimization (Build failed)

`v.1.2.10` _22 July 2022_

- Sidebar Optimization

`v.1.2.9` _21 July 2022_

- Sidebar Optimization

`v.1.2.8` _20 July 2022_

- Sidebar Optimization + Icon Optimization + Badge Optimization

`v.1.2.7` _7 July 2022_

- Sidebar Implementation (Logo + Separator)

`v.1.2.6` _15 June 2022_

- Icon inside Button Optimization

`v.1.2.5` _9 June 2022_

- Icon inside Button Implementation + Optimization

`v.1.2.4` _12 May 2022_

- Fix Build + Storybook project migration to Stencil

`v.1.2.3` _6 May 2022_

- Fix Build

`v.1.2.2` _6 May 2022_

- Fix Build

`v.1.2.1` _6 May 2022_

- Fix Build

`v.1.2.0` _6 May 2022_

- First 66 Icons pack implemented

`v.1.1.3` _9 March 2022_

- Button Component Optimization

`v.1.1.2` _8 March 2022_

- Adding some icons on Icon Component

`v.1.1.1` _23 Febuary 2022_

- Adding some icons on Icon Component

`v.1.1.0` _22 Febuary 2022_

- New Build / Angular component lib creation

`v.1.0.23` _22 Febuary 2022_

- Placeholder Component Optimization
- Toast Component implemented
- Icon Component implemented

`v.1.0.22` _22 Febuary 2022_

- [ O Success ] Build fix

`v.1.0.21` _22 Febuary 2022_

- [ X Failed ] Build fix attempt

`v.1.0.20` _22 Febuary 2022_

- Placeholder Component Citeo / Adelphe fixes
- [ X Failed ] Build fix attempt

`v.1.0.19` _21 Febuary 2022_

- Placeholder Component Citeo / Adelphe implemented

`v.1.0.18` _11 Febuary 2022_

- Button Component Adelphe Style Tertiary implemented

`v.1.0.17` _7 January 2022_

- Badge Component Optimization

`v.1.0.16` _7 January 2022_

- Badge Component Optimization and Fixes
- Animation implementation

`v.1.0.15` _6 January 2022_

- Badge Component OK

`v.1.0.14` _December 2021_

- Button Component OK and implemented
- Radiobox/Checkbox/Groupbox Component OK

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