Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/decathlon/vitamin-ios
Decathlon Design System UI components for iOS & iPadOS applications
https://github.com/decathlon/vitamin-ios
components design design-system ios ios-library mobile ui ui-components uikit vitamin
Last synced: 4 days ago
JSON representation
Decathlon Design System UI components for iOS & iPadOS applications
- Host: GitHub
- URL: https://github.com/decathlon/vitamin-ios
- Owner: Decathlon
- License: apache-2.0
- Created: 2021-12-23T07:43:32.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-18T14:27:38.000Z (6 months ago)
- Last Synced: 2024-10-19T03:05:31.629Z (27 days ago)
- Topics: components, design, design-system, ios, ios-library, mobile, ui, ui-components, uikit, vitamin
- Language: Swift
- Homepage: https://www.decathlon.design
- Size: 9.94 MB
- Stars: 47
- Watchers: 7
- Forks: 14
- Open Issues: 23
-
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 iOS
Decathlon Design System libraries for iOS & iPadOS applications
## Introduction
[Decathlon Design System](https://decathlon.design) is the framework that helps our ecosystem to design and develop consistent and quality experiences.
For its [Digital section](https://www.decathlon.design/726f8c765/p/6145b2-overview), it is called Vitamin.
## Install
### SPM
Add Vitamin to the dependencies array of your package:
```swift
dependencies: [
.package(url: "https://github.com/Decathlon/vitamin-ios.git", .exact("0.13.0")),
// Any other dependencies...
],
```
Then, add Vitamin to the dependencies array of any target that depends on Vitamin.
For `SwiftUI`:
```swift
.target(name: "YourSwiftUITarget",
dependencies: [
.product(name: "VitaminSwiftUI", package: "vitamin-ios"),
// Any other dependencies...
]),
```
For `UIKit`:
```swift
.target(name: "YourUIKitTarget",
dependencies: [
.product(name: "Vitamin", package: "vitamin-ios"),
// Any other dependencies...
]),
```
A full example:
```swift
let package = Package(
name: "YourPackage",
products: [
// Your products
],
dependencies: [
.package(url: "https://github.com/Decathlon/vitamin-ios.git", .exact("0.13.0")),
// Any other dependencies...
],
targets: [
// Your target
.target(name: "YourUIKitTarget",
dependencies: [
.product(name: "Vitamin", package: "vitamin-ios"),
// Any other dependencies...
]),
.target(name: "YourSwiftUITarget",
dependencies: [
.product(name: "VitaminSwiftUI", package: "vitamin-ios"),
// Any other dependencies...
]),
]
)
```
### Cocoapods
```ruby
# for UIKitVersion
pod 'Vitamin', '= 0.13.0'
# for SwiftUI version
pod 'VitaminSwiftUI', = '0.13.0'
```
## Available elements
This library provides two types of elements: Foundations and Components.
Foundations are core bricks of Vitamin Design System, and Components are high level elements, built upon Foundations.
### Foundations
The following foundations are available :
| Element | Description | Documentation |
|---------|-------------|---------------|
|Assets | Set of graphic assets usable in the Design System. | [UIKit](./Sources/VitaminUIKit/Foundations/Assets#readme) [SwiftUI](./Sources/VitaminSwiftUI/Foundations/Assets#readme)|
|Colors | Semantics and base colors of the Design System. | [UIKit](./Sources/VitaminUIKit/Foundations/Colors#readme) [SwiftUI](./Sources/VitaminSwiftUI/Foundations/Colors#readme)|
|Icons | Set of icons usable in the Design System. | [UIKit](./Sources/VitaminUIKit/Foundations/Icons#readme) [SwiftUI](./Sources/VitaminSwiftUI/Foundations/Icons#readme)|
|Radiuses | Radiuses applicable to any view in the Design System. | [UIKit](./Sources/VitaminUIKit/Foundations/Radiuses#readme) [SwiftUI](./Sources/VitaminSwiftUI/Foundations/Radiuses#readme)|
|Shadows | Shadows applicable to any view in the Design System. | [UIKit](./Sources/VitaminUIKit/Foundations/Shadows#readme) [SwiftUI](./Sources/VitaminSwiftUI/Foundations/Shadows#readme)|
|Typography | Text styles usable in the Design System. | [UIKit](./Sources/VitaminUIKit/Foundations/Typography#readme) [SwiftUI](./Sources/VitaminSwiftUI/Foundations/Typography#readme)|
### Components
The following components are available :
| Component | Description | Documentation |
|-----------|-------------|---------------|
|Badge | Badges from the Vitamin Design System. | [UIKit](./Sources/VitaminUIKit/Components/Badge#readme) [SwiftUI](./Sources/VitaminSwiftUI/Components/Badge#readme)|
|Button | Different button styles from the Vitamin Design System. | [UIKit](./Sources/VitaminUIKit/Components/Button#readme) [SwiftUI](./Sources/VitaminSwiftUI/Components/Button#readme)|
|Progressbar | Different progressbar styles from the Vitamin Design System. | [UIKit](./Sources/VitaminUIKit/Components/Progressbar#readme)|
|SegmentedControl | SegmentedControl from the Vitamin Design System. | [UIKit](./Sources/VitaminUIKit/Components/SegmentedControl#readme)|
|Snackbar | Snackbar from the Vitamin Design System. | [UIKit](./Sources/VitaminUIKit/Components/Snackbar#readme)|
|Switch | Switch from the Vitamin Design System. | [UIKit](./Sources/VitaminUIKit/Components/Switch#readme)|
|Tag | Tag from the Vitamin Design System. | [UIKit](./Sources/VitaminUIKit/Components/Tag#readme)|
|TextField | Different text fields styles from the Vitamin Design System. | [UIKit](./Sources/VitaminUIKit/Components/TextField#readme) [SwiftUI](./Sources/VitaminSwiftUI/Components/TextField#readme)||
## Special thanks
Thank you to the [contributors](CONTRIBUTORS.md) involved in these vitamin-ios libraries _(even before they were Open Source)_. 💙
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 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.