Clay

Clay is Liferay's web implementation of the Lexicon Experience Language. Built with Bootstrap as a foundation, it's comprised of HTML, CSS, and JS.

🚨 This Branch contains the version of Clay v3, if you are looking for the components in Metal.js visit the 2.x branch.

Contents

• Browser support
• Packages
• Documentation
• Migration Guides
• Setup
• clayui.com
• Contributing
• License

Browser support

Packages

Clay repository follows the monorepo approach, all the major components that are the pillars of Clay are here in this repository.

• Clay CSS: The pillar to give colors and structure to Clay, where is the css and examples of HTML markups of the components.

• Clay React Components: A set of components that use clay-css and Lexicon guidelines, developed with React.js

• clayui.com: The source code for our documentation site.

Documentation

You can find the Clay documentation on the site. Here are some useful links:

• Getting Started
• Components
• CSS Framework
• Blog

Migration Guides

Do you already have the Clay v2 components implemented in your project? These guides will help you perform the migration from Clay v2 to v3.

• Migrate the Clay components from v2 to v3

Setup

To contribute to this project, here are the required steps to setup everything:

1. Clone this repository:

git clone https://github.com/liferay/clay.git

2. Download and install the latest lts version of Node.js for your operating system.

3. Install the required global dependencies:

npm install -g yarn

4. Install the project's dependencies:

yarn

4. Install the dependencies for each package and link them together:

yarn lerna

5. Build all packages:

yarn build

6. Compile all clay-css files and start the storybook server:

yarn workspace @clayui/css run build && yarn storybook

Additionally, you can run the tests for all packages with the following command:

yarn test

clayui.com

To contribute to the documentation, you can run the site locally to test your changes:

1. Navigate to the site's directory:

cd clayui.com

2. Install the dependencies:

yarn

3. Run the site in a development environment:

yarn develop

If you want to test in a production environment so that you do not take risks of inconsistencies, issue the following command in the root directory:

yarn site

Contributing

Feel free to create issues or submit pull requests. Clay is actively maintained and your contributions are always welcome.

Before opening a issue make sure it exists.

See the contribution guide for more details.

License

BSD License © Liferay, Inc.