@clevercloud/components

kind: 🏠 Home title: ' Readme'

Collection of Web Components by Clever Cloud

What is this?

This project contains a collection of Web Components made by Clever Cloud.

Some of those components are low-level like <cc-button>, <cc-input-text> or <cc-loader>, the other components are more high-level and specific to Clever Cloud's domain model.

We use them on different Web UIs we have (public and internal).

Why is it public?

• We want to share our knowledge and experience with Web Components along with the tooling we used to build them. We hope it will help others for their own components.
• We use those components ourselves but we also want our clients and partners to use them in their own custom Web UIs based on our products.
• We think it's a great way for our clients to give feedbacks (and even contributions) on small parts of our Web UIs.

Can I see those components?

All our components are showcased with "stories" using Storybook. You can see all our components (and their stories) on this preview.

Storybook is a great tool to present your components in many different situations. This way, you can check how they behave with different inputs (properties, attributes...) and make sure they produce the right outputs (emit events...).

We also use web-component-analyzer to generate a documentation spec sheet for each component. You can find it in the Notes tab of a component's story (example).

Can I use them in my project?

Sure, they're available on npm. Contact us if you want more details.

License

This project is licensed under the Apache-2.0.

We're using modified versions of two projects related to Leaflet:

• https://github.com/Leaflet/Leaflet.heat
• https://github.com/mourner/simpleheat

Both projects are licensed with BSD-2-Clause. They aren't updated anymore, and we wanted them to be exposed as modern ES modules. This is the main reason we decided to copy them in our own repo. The respective copyrights are at the top of each file:

• src/lib/leaflet-heat.js
• src/lib/simpleheat.js

Changelog

7.0.0 (2021-09-03)

⚠️ BREAKING CHANGES

• Browser support updated (Safari >=14), see browser support reference for details (BREAKING CHANGE).
• <cc-pricing-product-cellar>: delete component and replace it with a more generic component (BREAKING CHANGE)
• <cc-pricing-table>:
  • rename items to plans (BREAKING CHANGE)
  • replace currencyCode with currency in smart definition (BREAKING CHANGE)
• <cc-pricing-product>:
  • rename items to plans (BREAKING CHANGE)
  • replace currencyCode with currency in smart definition (BREAKING CHANGE)

Components

• <cc-beta>: replace rem with em
• <cc-button>: replace rem with em
• <cc-img>: replace rem with em
• <cc-input-number>: replace rem with em
• <cc-input-text>: replace rem with em
• <cc-loader>: replace rem with em
• <cc-toggle>: replace rem with em
• <cc-block>: introduce a ribbon and a noHead property
• <cc-zone>:
  • add CSS custom properties to customize colors
  • replace rem with em
• <cc-zone-input>:
  • fix zone list sort
  • move sortZones out in a lib
• New components:
  • <cc-pricing-product-consumption> (with smart definition)
    • this is the replacement for <cc-pricing-product-cellar>, it works for Cellar, FS Bucket, Pulsar
  • <cc-pricing-header>
  • <cc-pricing-estimation>
  • <cc-pricing-page> (with smart definition)
  • <cc-jenkins-info> (with smart definition)

For devs

• Replace aws-sdk with @aws-sdk/s3-client so we can stop relying on s3cmd for previews
  • You no longer need the .clever-components-previews.s3cfg but you will need env vars (see docs)