Giter VIP home page Giter VIP logo

clay's Introduction

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

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

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:

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.

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
  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:
yarn
  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

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
  1. Install the dependencies:
yarn
  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

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.

clay's People

Contributors

4lejandrito avatar ambrinchaudhary avatar boton avatar bryceosterhaus avatar carloslancha avatar dependabot[bot] avatar diegonvs avatar drakonux avatar edalgrin avatar fernandosouza avatar ilzamcmed avatar ivan-zaera avatar jbalsas avatar julien avatar kresimir-coko avatar marcoscv avatar marcoscv-work avatar markocikos avatar matuzalemsteles avatar natecavanaugh avatar pat270 avatar plhnk avatar sandrodw3 avatar selenaaungst avatar sergiojimcos avatar vbence86 avatar veroglez avatar victorg1991 avatar wincent avatar zenorocha avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

clay's Issues

Lexicon with Bootstrap 3.x

We are working on a Liferay project to migrate theme from Bootstrap 3 to Lexicon. Found that latest Lexicon is using Bootstrap Alpha version. We do have a lot of utility classes and methods from Bootstrap 3.0 that won't support in Lexicon with Bootstrap 4.

Can someone please help us to get the Lexicon with Bootstrap 3.x and not the Alpha/4.0 bootstrap.
Or please advice the workaround to use bootstrap3.x with Lexicon? Can I just replace the bootstrap 4 with the latest stable version which is Bootstrap 3.x?

Firefox issue with fieldsets

Firefox has some awkward fieldset styling involving width that interferes with the responsive table. This cannot be overriden without a Firefox-specific hack that is not provided in Bootstrap:

@-moz-document url-prefix() {
  fieldset { display: table-cell; }
}

For more information, read https://stackoverflow.com/questions/17408815/fieldset-resizes-wrong-appears-to-have-unremovable-min-width-min-content/17863685#17863685

For Bootstrap's documentation, see http://getbootstrap.com/css/#callout-tables-responsive-ff-fieldset

Sticker

Hi!

I'm implementing the sticker component in metal-clay but I'm having some issues with the styling. I've done following http://liferay.github.io/clay/content/badges-and-labels/ markup, but there're classes that doesn't exist like sticker-circle, sticker-default, sticker-static, etc.

Are those classes missing or do I have to use other markup?

Also I noticed that the previous .sticker had an absolute positioning by default (overwritten by .sticker-static if necessary). It would be very helpful having examples of the correct current markup.

Thx!

modal styles causes document to scroll to top in Chrome

This can be reproduced at http://liferay.github.io/lexicon/content/modals/ and also in liferay-portal. I think this is caused by the styles from the class modal-open that is appended to the body.

  1. Navigate to http://liferay.github.io/lexicon/content/modals/.
  2. Scroll down a bit and click the 'Large Modal' button or the 'Full Screen Modal' button.
  3. Close the modal.

Result: The page is scrolled back to the top.

Note: It seems like for the bottom 3 buttons on the Modal demo page, the bootstrap modal component is resetting the scroll position after the modal is closed.

Control for asynchronous requests

Hi!
I'm wondering if you'll provide some builtin functionality on the framework to provide visual feedback to the user while running AJAX processes.

For example, if the user hits a button that submits a form through AJAX, while the AJAX request is being processed the UI displays something to tell the user that an action is being done (typically some kind of spinning wheel or an state button like http://getbootstrap.com/javascript/#buttons-stateful)

Thanks. Juan.

Add new Lexicon icons

We need to create new icons for the following: info-circle, info-circle-open, caret-top, caret-bottom.

Add variables for sidenav transition values

When there is a fixed element on the page and I want it to transition with a sidenav, it's hard to figure out the transition duration and timing function used by the sidenav. So it would be useful to set those values with variables that can be used elsewhere.

So variables specifically for 0.5s and ease in _side_navigation.scss.

.sidenav-transition,
.sidenav-transition .sidenav-content,
.sidenav-transition .sidenav-menu-slider,
.sidenav-transition .sidenav-menu-slider .sidenav-menu {
    @include transition(all 0.5s ease);
}

Add support for placing text inside of the toggle's switch-handle

Right now, if you add text into the .toggle-switch-handle element, it will butt up against the toggle switch.
There are cases where someone may prefer to augment the data-label-* attributes with persistent text, or just use text with HTML elements inside of it, and forego the data-label-* attributes altogether.

The idea Patrick and I came up with was to support this by wrapping the text inside of a span with toggle-switch-text as the class name.
That will give it the same appearance as the data-label-* attributes.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.