In the ever-evolving landscape of web-applications, streamlining the creation of user interfaces (UIs) has become paramount. This is where web-component libraries and design systems come into play, offering a powerful combination to accelerate development, enhance consistency, and foster collaboration among developers.
Web-component libraries and design systems are crucial in the rapidly evolving web-applications landscape, accelerating development, enhancing consistency, and promoting collaboration.
Sponsored by Lime Technologies, Lime Elements is an open-source component library and a design system. It provides a high-quality set of well-designed, well-documented UI components, crafted in Stencil for enterprise-level products.
Our top developers and designers continuously improve Lime Elements, fixing bugs and adding new features. It serves as Lime Technologies' central repository for UI guidelines, standards, and components, ensuring a consistent brand experience across all our applications. Lime Elements standardizes colors, typography, layouts, and interactions for a cohesive, accessible user experience.
We invite you to leverage our web-component library and design system. It can streamline development, enhance consistency, ease collaboration, and deliver exceptional user experiences. Lime Elements can be instrumental in creating modern, scalable, and accessible web applications that resonate with users worldwide.
For a full list of components, along with live examples, please visit the documentation.
- To install, run
npm install @limetech/lime-elements.
To achieve a blazing fast rendering, our components' user interface utilizes a default cross-browser sans-serif font stack. As web components typically inherit font-related styles such as font-family, font-size, and color, we recommend defining these styles at a higher level, such as the <body> element. This is because we do not specify these defaults on each individual component.
To maintain consistency with the look & feel demonstrated in this documentation, we suggest incorporating the following styles into your project:
font-family: ui-sans-serif, system-ui, sans-serif;
font-size: 0.875rem;
font-style: normal;
font-weight: 400;
color: rgb(var(--contrast-1500));💡 About the color specified above, read more on our color system.
Feel free to customize the font-family and related styles to suit your project's needs. For example, you might prefer a different typeface like below:
font-family: 'Roboto', Arial, Verdana, sans-serif;At Lime, we utilize the Windows 10 icon set from Icons8. You may notice these icons in our components, such as the magnifying glass icon displayed as a leading icon on an input field.
If you're using Lime Elements in a non-Lime product, you'll need to provide your own icons. We're unable to redistribute Icons8's assets with our package due to licensing restrictions.
Providing your own icons is crucial as many of our components use an Icon interface. This interface allows you to specify an icon name, which corresponds to the filename of an SVG icon. For example, you can use this to display an icon on a button.
-
For Lime products:
To use
@lundalogik/lime-icons8, the/assetsfolder from@lundalogik/lime-icons8must be made available on the web-server. -
For non-Lime products:
To use a different icon set, the icons must be placed in a folder structure that looks like this:
assets/icons/<name-of-icon>.svgIf
assetsis placed in the root, no other setup is needed. The icons will be fetched with a relative URL from/assets/icons/<name-of-icon>.svg.If
assetsis placed in a sub-folder somewhere, the easiest way to make the icons available is to use the HTMLbaseelement:<base href="/my/parent/path/" />
If this is not enough, or if the
baseelement is already in use for something else, a global icon path can be configured with thelimel-configelement:<limel-config config={{iconPath: '/my/parent/path/'}} />
Components marked as @beta are not yet stable. Here's what you need to know:
- Breaking changes: We may change
@betacomponents in ways that break your code. We won't increase the major version number when we do this. - Unstable:
@betacomponents may have more bugs than other components. Use them at your own risk. - Feedback wanted: We offer
@betacomponents to get your input. Your feedback helps us improve them.
Remember: All components can change, but @beta components change more often and without warning.
- If you have a general question, or are in need of support, please open a Question issue on GitHub.
- To build and run the documentation locally on your machine, run
npm start. - To see what other scripts are available, run
npm run. - Please read our guidelines for contributers