westfr / vitamin-android

Decathlon Design System UI components for Android applications

Vitamin Android

Decathlon Design System 🎨

Android Decathlon Design System is based on Material Design components described on the official documentation and developed in a library 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

To start using Vitamin in your app, you can check the Vitamin module documentation

📦 Artifacts

Group	Description
com.decathlon.vitamin.foundation	Fundamental components of UI with texts, icons and colors.
com.decathlon.vitamin.buttons	Build UIs with ready to use Button components.
com.decathlon.vitamin.checkboxes	Build UIs with ready to use Checkbox components.
com.decathlon.vitamin.radiobuttons	Build UIs with ready to use RadioButton components.
com.decathlon.vitamin.switches	Build UIs with ready to use Switch components.
com.decathlon.vitamin.textinputs	Build UIs with ready to use TextInput components.
com.decathlon.vitamin.fabs	Build UIs with ready to use FloatingActionButton components.
com.decathlon.vitamin.modals	Build UIs with ready to use Modal components.
com.decathlon.vitamin.progressbars	Build UIs with ready to use Progressbar components.
com.decathlon.vitamin.menus	Build UIs with ready to use Menu components.
com.decathlon.vitamin.ratings	Build UIs with ready to use Rating components.
com.decathlon.vitamin	Build UIs with ready to use Decathlon's Visual Identity components.

📥 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:vitamin:<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:vitamin:<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.

📝 License

Copyright 2021 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.