Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit

feat(@clayui/core): adds new API to handle column sorting with accessibility support


Failed to load latest commit information.
Latest commit message
Commit time
October 21, 2021 18:52
September 15, 2023 16:50

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.


Browser support

Google Chrome Last 2 Microsoft Edge Latest Mozilla Firefox Last 2 and 52 Opera Latest Safari Last 2 Chrome Android Safari iOS Latest


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

  • The source code for our documentation site.


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

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.


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

  1. Clone this repository:
git clone
  1. Download and install the latest lts version of Node.js for your operating system.

  2. Install the required global dependencies:

npm install -g yarn
  1. Install the project's dependencies:
  1. Install the dependencies for each package and link them together:
yarn lerna
  1. Build all packages:
yarn build
  1. 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

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

  1. Navigate to the site's directory:
  1. Install the dependencies:
  1. 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


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.


BSD License © Liferay, Inc.