Vitamin Compose
Decathlon Design System libraries for android applications
Compose Decathlon Design System is based on Material Design compose artifact described on the official documentation 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. 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.
VitaminTheme {
// Your composable declarations
}
? Download
Release artifacts are available on Maven Central. Check the release page to know what is the latest release version of Vitamin artifacts.
repositories {
mavenCentral()
}
implementation("com.decathlon.vitamin.compose:<component>:<last_version>")
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.
repositories {
maven {
url = uri("https://oss.sonatype.org/content/repositories/snapshots/")
}
}
implementation("com.decathlon.vitamin.compose:<component>:<latest-major + 1>.0.0-SNAPSHOT")
If you have any question about the versioning of this project, you can just read our documentation about it.
Special thanks
Thank you to the contributors involved in these vitamin-compose libraries. ?
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.
