hub / github.com/Lundalogik/lime-elements

github.com/Lundalogik/lime-elements @v39.40.0

Chat with this repo

repository ↗ · DeepWiki ↗ · release v39.40.0 ↗ · + Follow

3,562 symbols 6,807 edges 953 files 104 documented · 3%

What it actually does AI analysis from the code graph — generated when you open this

loading…

README

Lime Elements

Modern Web Components for Enterprise Applications

A comprehensive design system and component library built with Stencil

Why Lime Elements?

🚀 Enterprise-Ready - Battle-tested components used in production applications
🎨 Design System - Consistent UX/UI design with comprehensive usage guidelines
⚡ Web Standards - Built with Stencil, works with any framework
👾 TypeScript - Full type safety and excellent developer experience
♿ Accessible - Built with accessibility in mind
⚙️ Customizable - Extensive styling options

Sponsored by Lime Technologies, Lime Elements is a production-ready component library and design system built with Stencil. Our enterprise-grade components help you create consistent, scalable, and accessible web applications faster.

Whether you're building from scratch or enhancing existing applications, Lime Elements provides the building blocks for exceptional user experiences that work across all modern frameworks.

Visit our 📚 Documentation for comprehensive guides and examples, or install directly from 📦 NPM.

Recent Updates

🆕 What's New: Get an overview of the recent most noteworthy updates and features
📋 Changelog: Check our changelog for detailed info about the new features, bug fixes, and design improvements

Project Status

Quality & Reliability

Technology & Standards

Community & Activity

Quick Start


<script type="module" src="https://cdn.jsdelivr.net/npm/@limetech/lime-elements@latest/dist/lime-elements/lime-elements.esm.js"></script>


<limel-input-field
    label="Name"
    placeholder="Enter your full name"
></limel-input-field>
<limel-button primary label="Submit"></limel-button>

Try it live in our playground

Getting Started

To install, run npm install @limetech/lime-elements.

Requirements

1. Font

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;

2. Icons

At Lime, we utilize the Windows 11 Outline 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.

How to Set Up Your Icons Folder

For Lime products:

To use @lundalogik/lime-icons8, the /assets folder from @lundalogik/lime-icons8 must 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>.svg

If assets is 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 assets is placed in a sub-folder somewhere, the easiest way to make the icons available is to use the HTML base element:

html <base href="https://github.com/Lundalogik/lime-elements/raw/v39.40.0/my/parent/path/" />

If this is not enough, or if the base element is already in use for something else, a global icon path can be configured with the limel-config element:

ts <limel-config config={{iconPath: '/my/parent/path/'}} />

Using @beta Components

Components marked as @beta are not yet stable. Here's what you need to know:

Breaking changes: We may change @beta components in ways that break your code. We won't increase the major version number when we do this.
Unstable: @beta components may have more bugs than other components. Use them at your own risk.
Feedback wanted: We offer @beta components to get your input. Your feedback helps us improve them.

Remember: All components can change, but @beta components change more often and without warning.

Community & Support

💬 Questions? create an issue
🐛 Found a bug? Report it here
💡 Feature request? Share your ideas
🆕 Changelog Check our changelog for detailed info about the new features, bug fixes, and design improvements

Contributing

We welcome contributions from the community! Here's how you can help:

🔍 Found an issue? Feel free to fix it and submit a PR
📝 Improve docs? Documentation improvements are always appreciated
🎨 Design feedback? Share your UX insights
🧪 Testing? Help us test new features and report bugs

Quick Set Up

git clone https://github.com/Lundalogik/lime-elements.git
cd lime-elements
npm install
npm start  # Starts local development server

📋 Read our full contributing guidelines

AI-Friendly Documentation

Lime Elements generates Context7-compatible markdown documentation to help AI coding assistants and LLMs better understand and use our component library. This documentation is automatically published with each release and includes:

📄 Component API docs - Detailed markdown documentation for all components
📚 Design guidelines - Best practices and usage patterns
🎯 Usage rules - Context7 rules for proper component usage
🔗 Navigation index - Searchable overview of all components and guides

The documentation is available at: - Latest version: lundalogik.github.io/lime-elements/versions/latest/markdown-docs/INDEX.md - Configuration: context7.json

This makes Lime Elements easier to work with when using AI pair programming tools like GitHub Copilot, Cursor, or Claude Code.

📄 License

Lime Elements is open source software licensed under the Apache 2.0 License.

Built with ❤️ by your friends at Lime Technologies

Empowering developers to create amazing user experiences

⭐ Star us on GitHub • 📚 Documentation • 📦 NPM

Extension points exported contracts — how you extend this code

ContentTypeConverter (Interface)

(no doc) [2 implementers]

src/components/text-editor/utils/content-type-converter.ts

FileInfo (Interface)

(no doc)

src/global/shared-types/file.types.ts

RGB (Interface)

(no doc)

src/util/adapt-color-contrast.ts

FormComponent (Interface)

(no doc) [2 implementers]

src/components/form/form.types.ts

ListSeparator (Interface)

(no doc)

src/global/shared-types/separator.types.ts

RGBA (Interface)

(no doc)

src/util/adapt-color-contrast.ts

ErrorSchemaNode (Interface)

* Represents a nested error schema structure from rjsf validation. * Each level can contain __errors array and nested c

src/components/form/widgets/code-editor.ts

IconNameRegistry (Interface)

(no doc)

src/global/shared-types/icon.types.ts

Core symbols most depended-on inside this repo

createElement

called by 119

src/components/table/element-pool.ts

get

called by 99

src/components/table/element-pool.ts

markdownToHTML

called by 50

src/components/markdown/markdown-parser.ts

renderForm

called by 46

src/components/form/form.e2e.tsx

formatDisplayToken

called by 44

src/components/hotkey/format-display-token.ts

createRandomString

called by 38

src/util/random-string.ts

remove

called by 36

src/components/snackbar/container.ts

sanitizeEmailHTML

called by 35

src/components/email-viewer/sanitize-email-html.ts

Shape

Method 1,644

Class 1,271

Function 523

Interface 122

Enum 2

Languages

TypeScript100%

Modules by API surface

src/components/table/table.tsx58 symbols

src/components/code-diff/code-diff.tsx44 symbols

src/components/chip-set/chip-set.tsx40 symbols

src/components/picker/picker.tsx39 symbols

src/components/select/select.tsx28 symbols

src/components/email-viewer/email-loader.ts27 symbols

src/components/portal/portal.tsx26 symbols

src/components/code-editor/code-editor.tsx24 symbols

vitest-setup.ts23 symbols

src/components/tab-bar/tab-bar.tsx22 symbols

src/components/chart/chart.tsx22 symbols

src/components/text-editor/prosemirror-adapter/prosemirror-adapter.tsx21 symbols

For agents

$ claude mcp add lime-elements \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

github.com/Lundalogik/lime-elements @v39.40.0

Lime Elements

Why Lime Elements?

Recent Updates

Project Status

Quality & Reliability

Technology & Standards

Community & Activity

Quick Start

Getting Started

Requirements

1. Font

2. Icons

How to Set Up Your Icons Folder

Using @beta Components

Community & Support

Contributing

AI-Friendly Documentation

📄 License

Extension points exported contracts — how you extend this code

Core symbols most depended-on inside this repo

Shape

Languages

Modules by API surface

For agents

Ask about this repo answers extend the page