Compound is the work-in-progress design system for the Element applications.
This repository contains all the public documentation for Compound.
- 🎨 Compound design tokens – All tokens packaged for platforms to use
- 📱 Compound iOS – iOS components library
- 🤖 Compound Android – Android components library
- 🌐 Compound Web – Web components library
This project is using Storybook to document the design system. It gets automatically deployed when a new commit is pushed to the main branch. To develop locally, you will need node and yarn.
Once installed, run the following command at the root of this project
yarn && yarn storybook
The core team uses this board to track work, using the columns for:
- 'New': New or draft issues.
- 'Backlog': Issue backlog, triaged in priority order.
- 'Triaged': Committed tasks, triaged in priority order.
- 'In progress': In progress issues. Issues must have an assignee, and can have multiple.
- 'Blocked': Progress blocked. Raise during standups.
- 'In review' & 'Done'
Copyright (c) 2023-2025 New Vector Ltd
This software is multi licensed by New Vector Ltd (Element). It can be used either:
(1) for free under the terms of the GNU Affero General Public License (as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version); OR
(2) under the terms of a paid-for Element Commercial License agreement between you and Element (the terms of which may vary depending on what you and Element have agreed to). Unless required by applicable law or agreed to in writing, software distributed under the Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.