@contentful/f36-inputs

Forma 36: Input React Components

Usage no npm install needed!

<script type="module">
  import contentfulF36Inputs from 'https://cdn.skypack.dev/@contentful/f36-inputs';
</script>

README

Forma 36 - The Contentful Design System

Contentful All Contributors lerna

Forma 36 is an open-source design system by Contentful created with the intent to reduce the overhead of creating UI by providing tools and guidance for digital teams building and extending Contentful products

Table of contents

Creating new packages

We use use Plop to create scripts that help you to scaffold new packages. In the root of the repo, you can run yarn generate. Then follow the steps in the CLI. Plop will generate the relevant files and add the relevant imports and exports to the main src/index.ts file required to make the component available when publishing the library. Read more about contribution to Forma 36.

Development

For local development, in the root of the repo run yarn to install all dependencies and then yarn build to build all packages. Now follow the instructions of the specific package you’re working on. You will find each package’s instructions in their README files, check the Packages section for a list of all packages.

In case you are having problems to install the dependencies, try using NVM to get the same node version we use by running nvm use in the root of the repo

Storybook for f36-components

We use storybook with our react component library to develop components. You can start it from the root of the repo, just run yarn storybook

Commits & releases

Use yarn commit. This uses the Commitzen CLI to create a conventional commit message based on your changes. CI is setup to release all new commits on the master branch.

Testing with your own project locally

You can test changes to a package of this monorepo in your own project locally by taking the following steps:

  1. Run yarn build in the desired package's directory to ensure your latest changes have been built
  2. Run yarn link in the desired package's directory
  3. Change to your local project's directory and run yarn link NAME_OF_PACKAGE to link to the local version of the package (e.g. yarn link @contentful/f36-components)

Get involved

PRs Welcome

We appreciate any help on our repositories. For more details about how to contribute to a package, see the README of the corresponding package.

Reach out to us

You can reach out to us using the Contentful community Slack. We've setup a channel #forma36 in which we announce latest changes and updates.

You found a bug or want to propose a feature?

Create an issue using one of the templates File an issue. Make sure to remove any credential from your code before sharing it.

License

This repository is published under the MIT license.

Code of Conduct

We want to provide a safe, inclusive, welcoming, and harassment-free space and experience for all participants, regardless of gender identity and expression, sexual orientation, disability, physical appearance, socioeconomic status, body size, ethnicity, nationality, level of experience, age, religion (or lack thereof), or other identity markers.

Read our full Code of Conduct.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Mike Mitchell

πŸ’» 🚧

Johannes Bugiel

πŸ’» 🚧

Gui Santos

πŸ’» 🚧 πŸ“–

Moe Shaaban

πŸ’» 🚧 πŸ“–

Patrycja RadaczyΕ„ska

πŸ’» 🚧 πŸ“–

Dominik Markuőić

🎨 πŸ“–

Kristoffer

πŸ’» 🚧

Alexander Suevalov

πŸ’» 🚧

Gracegross

🎨

Miretxu

πŸ’»

Tanya Bessonova

πŸ’»

John Whiles

πŸ’»

Guilherme Barbosa

πŸ’»

Marco Link

πŸ’»

David Fateh

πŸ’»

Bruce Felt

πŸ’»

Daniel Vasylenko

πŸ’»

kdamball

πŸ’»

MarkusLaut

πŸ’»

Andreas HΓΆrnicke

πŸ’»

ChidinmaOrajiaku

πŸ’»

Andi PΓ€tzold

πŸ’» πŸ›

Wiktoria Dalach

πŸ’»

Joshua Smock

πŸ’»

Yiotis Kaltsikis

πŸ’»

Azer Koçulu

πŸ’»

taye

πŸ’»

dannyiacono

πŸ’»

Grant Sauer

πŸ’»

JoΓ£o Ramos

πŸ’»

Ante Sepic

πŸ’» πŸ›

Blair Rampling

πŸ’»

Daniel A. R. Werner

πŸ’»

Sergii Bezliudnyi

πŸ’»

Manuel Spagnolo

πŸ’»

Mohamed Turki

πŸ’»

Ahmed T. Ali

πŸ’»

Bruno Russi Lautenschlager

πŸ’»

Chris Towler

πŸ’» πŸ›

Christoph Grabo

πŸ’»

Colton Colcleasure

πŸ’»

Connor BΓ€r

πŸ’»

Danil Zakablukovskii

πŸ’»

Dominic Bonnice

πŸ’»

Khaled Garbaya

πŸ’»

Stefan Judis

πŸ’»

Thomas Jaggi

πŸ’»

Turcan Vladimir

πŸ’»

V. Milone

πŸ’»

Aris Plakias

πŸ’»

Kam Figy

πŸ›

Peter Wielander

πŸ’» πŸ›

Felix Boenke

πŸ›

damienxy

πŸ’» πŸ›

Nika Zawila

πŸ’» 🚧 πŸ“–

Sarah

πŸ“–

th1nkgr33n

πŸ›

Thomas Kellermeier

πŸ› πŸ’»

Ikko Ashimine

πŸ“–

Anil Kumar krishanshetty

πŸ’» πŸ“–

Renato Massao Yonamine

πŸ’»

Charlie Chrisman

πŸ›

Jan van den Berg

πŸ’»

SirGavin

πŸ›

Kathrin Holzmann

πŸ’» 🚧

Bohdan Hutsol

πŸ’» 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!