-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* Update documentation structure to support versioning * Update changelog * review Reviewed-by: Pierre-Yves Lapersonne <[email protected]>
- Loading branch information
Showing
244 changed files
with
5,054 additions
and
86 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
layout: detail | ||
title: "Cookies" | ||
description: Manage cookies preferences. | ||
--- | ||
|
||
At any time, you can manage your cookies preferences for this website from the <a href="javascript:tarteaucitron.userInterface.openPanel();">cookies management panel</a>. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
layout: main | ||
title: Cookies | ||
content_page: Cookies.md | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
layout: detail | ||
title: License | ||
description: Commonly asked questions about ODS iOS open source license. | ||
--- | ||
|
||
## ODS iOS license | ||
|
||
ODS iOS is released under the MIT license and is copyright Orange SA, which is released under MIT license. | ||
|
||
## It requires you to: | ||
|
||
- Keep the license and copyright notice included in ODS iOS Swift files when you use them in your works | ||
|
||
## It permits you to: | ||
|
||
- Freely download and use ODS iOS, in whole or in part, for personal, private, company internal, or commercial purposes | ||
- Use ODS iOS in packages or distributions that you create | ||
- Modify the source code | ||
- Grant a sublicense to modify and distribute ODS iOS to third parties not included in the license | ||
|
||
## It forbids you to: | ||
|
||
- Hold the authors and license owners liable for damages as ODS iOS is provided without warranty | ||
- Hold the creators or copyright holders of ODS iOS liable | ||
- Redistribute any piece of ODS iOS without proper attribution | ||
- Use any marks owned by Orange SA in any way that might state or imply that Orange SA endorses your distribution | ||
- Use any marks owned by Orange SA in any way that might state or imply that you created the Orange SA software in question | ||
|
||
## It does not require you to: | ||
|
||
- Include the source of ODS iOS itself, or of any modifications you may have made to it, in any redistribution you may assemble that includes it | ||
- Submit changes that you make to ODS iOS back to its project (though such feedback is encouraged) | ||
|
||
For more information, the full ODS iOS license is located [in the project repository](https://github.com/Orange-OpenSource/ods-ios/blob/main/LICENSE). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
layout: main | ||
title: License | ||
content_page: License.md | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
layout: detail | ||
title: Team | ||
description: An overview of the founding team and core contributors to ODS iOS. | ||
--- | ||
|
||
ODS iOS is maintained by the core team and a small group of invaluable core contributors, with the support and involvement of our community. | ||
|
||
{% if site.data.team.ODS_iOS[0] %} | ||
<div class="list-group mb-3"> | ||
{% for team_member in site.data.team.ODS_iOS %} | ||
<a class="list-group-item list-group-item-action d-flex align-items-center" href="https://github.com/{{ team_member.gh_pseudo }}"> | ||
<img src="https://github.com/{{ team_member.gh_pseudo }}.png" alt="@{{ team_member.gh_pseudo }}" width="32" height="32" class="me-2" loading="lazy"> | ||
<span class="fw-normal"> | ||
<strong>{{ team_member.name }}</strong> @{{ team_member.gh_pseudo }} | ||
</span> | ||
</a> | ||
{% endfor %} | ||
</div> | ||
{% endif %} | ||
|
||
Get involved with ODS iOS development by [opening an issue](https://github.com/Orange-OpenSource/ods-ios/issues/new/choose) or submitting a pull request. Read our [contributing guidelines](https://github.com/Orange-OpenSource/ods-ios/blob/main/CONTRIBUTING.md) for information on how we develop. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
layout: main | ||
title: Team | ||
content_page: Team.md | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
--- | ||
layout: detail | ||
title: Banners | ||
description: A banner displays an important message which requires an action to be dismissed. | ||
--- | ||
|
||
--- | ||
|
||
**Page Summary** | ||
|
||
* Table of contents | ||
{:toc} | ||
|
||
--- | ||
|
||
A banner displays an important, succinct message, and provides actions for users to address (or dismiss the banner). It requires a user action to be dismissed. | ||
|
||
Banners should be displayed at the top of the screen, below a top app bar. They’re persistent and nonmodal, allowing the user to either ignore them or interact with them at any time. Only one banner should be shown at a time | ||
|
||
![Banner light](images/banner-light.png) | ||
![Banner dark](images/banner-dark.png) | ||
|
||
## Specifications references | ||
|
||
- [Design System Manager - Banners](https://system.design.orange.com/0c1af118d/p/85a52b-components/b/1497a4) | ||
|
||
## Accessibility | ||
|
||
Please follow [accessibility criteria for development](https://a11y-guidelines.orange.com/en/mobile/ios/) | ||
|
||
## Variants | ||
|
||
### No button | ||
|
||
```swift | ||
ODSBanner(text: "One to two lines is preferable on mobile and tablet.", | ||
imageSource: .image(Image("placeholder", bundle: Bundle.ods))) | ||
``` | ||
|
||
### One button | ||
|
||
The button is placed under the text. | ||
|
||
```swift | ||
ODSBanner(text: "One to two lines is preferable on mobile and tablet.", | ||
imageSource: .image(Image("placeholder", bundle: Bundle.ods))) { | ||
Button("Button") { | ||
// your action here | ||
} | ||
} | ||
``` | ||
|
||
### Two buttons | ||
|
||
Button are placed under the text. | ||
|
||
```swift | ||
ODSBanner(text: "One to two lines is preferable on mobile and tablet.", | ||
imageSource: .image(Image("placeholder", bundle: Bundle.ods))) { | ||
Button("Button 1") { | ||
// your action here | ||
} | ||
} secondButton: { | ||
Button("Button 1") { | ||
// your action here | ||
} | ||
} | ||
``` | ||
|
||
### Without image | ||
|
||
```swift | ||
ODSBanner(text: "One to two lines is preferable on mobile and tablet.") { | ||
Button("Button 1") { | ||
// your action here | ||
} | ||
} secondButton: { | ||
Button("Button 1") { | ||
// your action here | ||
} | ||
} | ||
``` | ||
|
||
### With image from url | ||
|
||
```swift | ||
|
||
let placeholder = Image("placeholder", bundle: Bundle.ods) | ||
let url = URL(string: "https://images.unsplash.com/photo-1615735487485-e52b9af610c1?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=774&q=80") | ||
|
||
ODSBanner(text: "One to two lines is preferable on mobile and tablet.", | ||
imageSource: .asyncImage(url, placeholder)) { | ||
Button("Button 1") { | ||
// your action here | ||
} | ||
} secondButton: { | ||
Button("Button 1") { | ||
// your action here | ||
} | ||
} | ||
``` | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
layout: main | ||
title: Banners | ||
content_page: banners.md | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
--- | ||
layout: detail | ||
title: Bars - navigation | ||
description: Navigation bar with Orange branding | ||
--- | ||
|
||
--- | ||
|
||
**Page Summary** | ||
|
||
* Table of contents | ||
{:toc} | ||
|
||
--- | ||
|
||
## Specifications references | ||
|
||
- [Design System Manager - Bars: navigation](https://system.design.orange.com/0c1af118d/p/34094d-bars-navigation/b/419eb1) | ||
- [Apple guideline - Navigation bars](https://developer.apple.com/design/human-interface-guidelines/components/navigation-and-search/navigation-bars/) | ||
|
||
## Accessibility | ||
|
||
Please follow [accessibility criteria for development](https://a11y-guidelines.orange.com/en/mobile/ios/) | ||
|
||
## Standard navigation bar | ||
|
||
![Navigation bar standard light](images/bars_navigation_standard_light.png) | ||
![Navigation bar standard dark](images/bars_navigation_standard_dark.png) | ||
|
||
When using a navigation view, basic navigation is using 'inline' display mode by default. | ||
|
||
```swift | ||
NavigationView { | ||
NavigationLink(destination: Text("destination")) { | ||
Text("Main view") | ||
} | ||
.navigationBarTitle("Standard", displayMode: .inline) | ||
} | ||
|
||
``` | ||
|
||
## Navigation bar with large title | ||
|
||
![Navigation bar large light](images/bars_navigation_large_light.png) | ||
![Navigation bar large dark](images/bars_navigation_large_dark.png) | ||
|
||
Use 'large' display mode to enable large titles when scrolling up. | ||
|
||
```swift | ||
NavigationView { | ||
NavigationLink(destination: Text("destination")) { | ||
Text("Main view") | ||
} | ||
.navigationBarTitle("Standard", displayMode: .large) | ||
} | ||
|
||
``` | ||
|
||
## Navigation bar with search bar | ||
|
||
![Navigation bar search light](images/bars_navigation_search_light.png) | ||
![Navigation bar search dark](images/bars_navigation_search_dark.png) | ||
|
||
|
||
Use .searchable modifier to add a search bar in the navigation view. | ||
|
||
```swift | ||
@State var searchQuery = "" | ||
|
||
NavigationView { | ||
NavigationLink(destination: Text("destination")) { | ||
Text("Main view") | ||
} | ||
.navigationBarTitle("With search bar", displayMode: .inline) | ||
.searchable(text: $searchQuery, placement: .navigationBarDrawer(displayMode: .always)) | ||
} | ||
|
||
``` | ||
|
||
## Navigation bar with action item | ||
|
||
![Navigation bar items light](images/bars_navigation_items_light.png) | ||
![Navigation bar items dark](images/bars_navigation_items_dark.png) | ||
|
||
You can add one or several buttons (trailing or leading) in the navigation view by using .toolbar modifier | ||
|
||
```swift | ||
NavigationView { | ||
NavigationLink(destination: Text("destination")) { | ||
Text("Main view") | ||
} | ||
.navigationBarTitle("Standard", displayMode: .inline) | ||
.toolbar { | ||
ToolbarItem(placement: .navigationBarTrailing) { | ||
Button { | ||
print("item action") | ||
} label: { | ||
Image(systemName: "ant.circle") | ||
} | ||
} | ||
} | ||
} | ||
|
||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
layout: main | ||
title: Bars - navigation | ||
content_page: barsNavigation.md | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
--- | ||
layout: detail | ||
title: Bars - tab | ||
description: Tab bars with Orange branding | ||
--- | ||
|
||
--- | ||
|
||
**Page Summary** | ||
|
||
* Table of contents | ||
{:toc} | ||
|
||
--- | ||
|
||
## Specifications references | ||
|
||
- [Design System Manager - Bars: tab](https://system.design.orange.com/0c1af118d/p/08dab8-bars-tab/b/778ed0) | ||
- [Apple guideline - Tab bars](https://developer.apple.com/design/human-interface-guidelines/components/navigation-and-search/tab-bars/) | ||
|
||
## Accessibility | ||
|
||
Please follow [accessibility criteria for development](https://a11y-guidelines.orange.com/en/mobile/ios/) | ||
|
||
## Standard tab bar | ||
|
||
![Tab bar light](images/bars_tab_light.png) | ||
![Tab bar dark](images/bars_tab_dark.png) | ||
|
||
Tab bar is a standard iOS component. It uses bar items to navigate between views. | ||
Bar Item contains an icon and a title. | ||
An additonal badge can be also added with a count value or a text. | ||
|
||
Example with 4 bar items : | ||
|
||
```swift | ||
TabView { | ||
GuidelinesList() | ||
.tabItem { | ||
Label("Guidelines", image: "Guideline-DNA_32") | ||
} | ||
.badge("Text") | ||
ComponentsList() | ||
.tabItem { | ||
Label("Components", image: "component-atom_32") | ||
} | ||
ModulesList() | ||
.tabItem { | ||
Label("Modules", image: "Module-molecule_32") | ||
} | ||
.badge(10) | ||
ODSDemoAboutView() | ||
.tabItem { | ||
Label("About", image: "info_32") | ||
} | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
layout: main | ||
title: Bars - tab | ||
content_page: barsTab.md | ||
--- |
Oops, something went wrong.