https://github.com/decathlon/vitamin-compose

Decathlon Design System UI components for Compose applications
https://github.com/decathlon/vitamin-compose

components compose decathlon design-system vitamin

Last synced: 3 days ago
JSON representation

Decathlon Design System UI components for Compose applications

• Host: GitHub
• URL: https://github.com/decathlon/vitamin-compose
• Owner: Decathlon
• License: apache-2.0
• Created: 2022-05-16T07:27:12.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-21T08:58:42.000Z (12 months ago)
• Last Synced: 2024-05-15T08:46:38.285Z (6 months ago)
• Topics: components, compose, decathlon, design-system, vitamin
• Language: Kotlin
• Homepage: https://www.decathlon.design
• Size: 9.24 MB
• Stars: 251
• Watchers: 5
• Forks: 28
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
> [!IMPORTANT]

> This current version of Vitamin will no longer evolve and only accept bug fixes from now on. [More details here](https://github.com/Decathlon/vitamin-design/blob/main/IMPORTANT_NOTE.md).






  

  



Vitamin Compose


Decathlon Design System libraries for android applications




  Website





  

    

  

  

    

  

  

    

  

  

    

  



Compose Decathlon Design System is based on Material Design compose artifact described

on the [official documentation](https://material.io/) and maintained by Google developers

and designers.

But these native components are overridden to respect Decathlon's Visual Identity. You'll find

the design specifications and technical information for supported platforms by Decathlon on

[decathlon.design](https://www.decathlon.design/). If you are interested by a sample,

you can install a demo with `sample` module in the technical project.

## 🚀 Getting Started

A `VitaminTheme` is available in foundation artifact from where you can get all

colors, typographies and shapes in your composable hierarchy. Note that this theme is

mandatory if you want to use any composable available in other vitamin compose artifacts.

If you don't use it, an error will be triggered at the runtime.

```kotlin

VitaminTheme {

  // Your composable declarations

}

```

## 📥 Download

Release artifacts are available on Maven Central. Check the [release page](https://github.com/Decathlon/vitamin-compose/releases)

to know what is the latest release version of Vitamin artifacts.

```kotlin

repositories {

    mavenCentral()

}

implementation("com.decathlon.vitamin.compose::")

```

If you want to test latest changes merge in `main` branch, you can test Vitamin Android from

snapshot artifacts but we don't recommend to use theses artifacts in production where you can

have regressions or breaking changes until the next official release.

```kotlin

repositories {

    maven {

        url = uri("https://oss.sonatype.org/content/repositories/snapshots/")

    }

}

implementation("com.decathlon.vitamin.compose::.0.0-SNAPSHOT")

```

If you have any question about the versioning of this project, you can just read our [documentation](https://github.com/Decathlon/vitamin-compose/tree/main/VERSIONING.md)

about it.

## Special thanks

Thank you to the [contributors](https://github.com/Decathlon/vitamin-compose/graphs/contributors) involved in these vitamin-compose libraries. 💙



  



Thank you also [Remix Icon](https://remixicon.com) because Vitamix Icons is the official Decathlon icon library based on their [open-source icon library](https://github.com/Remix-Design/RemixIcon) (Remix Design © 2020). This original library is under the license Apache 2.0 and has been modified by Decathlon. [Learn more](https://www.decathlon.design/726f8c765/p/58575f-vitamix-license).

## License

    Copyright 2022 Decathlon.

    Licensed under the Apache License, Version 2.0 (the "License");

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an "AS IS" BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.