-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update DocC documentation for version v0.5.0 (1731487049)
Update documentation for GitHub pages of version v0.5.0 of OUDS iOS library (build timestamp 1731487049) WARNING: This is an automatic commit 🤖
- Loading branch information
Showing
6,866 changed files
with
28,350 additions
and
5,360 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
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 |
---|---|---|
@@ -1 +1 @@ | ||
{"primaryContentSections":[{"kind":"content","content":[{"type":"heading","anchor":"overview","text":"Overview","level":2},{"type":"paragraph","inlineContent":[{"text":"❗**More details coming soon.**❗","type":"text"}]},{"text":"How to use components","level":2,"anchor":"How-to-use-components","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Import the target of components, and use the component you want:"}]},{"syntax":"swift","code":["import OUDSComponents \/\/ To get the components"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Of course you must use in your root view the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/OUDS\/documentation\/OUDS\/OUDSThemeableView"},{"type":"text","text":" with the suitable theme:"}]},{"type":"codeListing","syntax":"swift","code":[" \/\/ The theme can be OrangeTheme or your own"," OUDSThemeableView(theme: theTheme) {"," "," }"]}]}],"sections":[],"kind":"article","metadata":{"role":"article","title":"Components","modules":[{"name":"OUDS"}],"roleHeading":"Article"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"emphasis","inlineContent":[{"text":"Components","type":"text"}]},{"text":" are defined in the ","type":"text"},{"identifier":"https:\/\/ios.unified-design-system.orange.com\/documentation\/oudstokenscomponent\/","isActive":true,"type":"reference"},{"text":" target and can be integrated in applications.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/ouds\/components"]}],"hierarchy":{"paths":[["doc:\/\/OUDS\/documentation\/OUDS"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/OUDS\/documentation\/OUDS\/Components"},"seeAlsoSections":[{"identifiers":["doc:\/\/OUDS\/documentation\/OUDS\/GettingStarted","doc:\/\/OUDS\/documentation\/OUDS\/Tokens","doc:\/\/OUDS\/documentation\/OUDS\/Themes","doc:\/\/OUDS\/documentation\/OUDS\/Modules"],"title":"Essentials","generated":true}],"references":{"doc://OUDS/documentation/OUDS":{"identifier":"doc:\/\/OUDS\/documentation\/OUDS","role":"collection","type":"topic","title":"OUDS","abstract":[{"text":"The iOS library of ","type":"text"},{"inlineContent":[{"text":"Orange Unified Design System Design System","type":"text"}],"type":"emphasis"},{"type":"text","text":", the new design system unified and cohesive across all platforms to build Orange mobile applications."}],"kind":"symbol","url":"\/documentation\/ouds"},"doc://OUDS/documentation/OUDS/GettingStarted":{"identifier":"doc:\/\/OUDS\/documentation\/OUDS\/GettingStarted","title":"Getting Started with OUDS","abstract":[{"type":"text","text":"How to add the package as dependency, and import libraries"}],"role":"article","kind":"article","type":"topic","url":"\/documentation\/ouds\/gettingstarted"},"doc://OUDS/documentation/OUDS/OUDSThemeableView":{"url":"\/documentation\/ouds\/oudsthemeableview","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"OUDSThemeableView","kind":"identifier"}],"title":"OUDSThemeableView","type":"topic","abstract":[{"type":"text","text":"This is a kind of root "},{"type":"codeVoice","code":"SwiftUI.View"},{"text":" to add at the top level of your views tree so as to define","type":"text"},{"type":"text","text":" "},{"type":"text","text":"as an environement variable the theme which will be applied."},{"text":" ","type":"text"},{"text":"Any theme to apply must be a child of ","type":"text"},{"type":"codeVoice","code":"OUDSTheme"},{"type":"text","text":", direct or not."}],"navigatorTitle":[{"text":"OUDSThemeableView","kind":"identifier"}],"identifier":"doc:\/\/OUDS\/documentation\/OUDS\/OUDSThemeableView","role":"symbol","kind":"symbol"},"doc://OUDS/documentation/OUDS/Themes":{"title":"Themes","type":"topic","role":"article","url":"\/documentation\/ouds\/themes","abstract":[{"inlineContent":[{"type":"text","text":"Themes"}],"type":"emphasis"},{"text":" are applications of specific values for ","type":"text"},{"type":"emphasis","inlineContent":[{"text":"components tokens","type":"text"}]},{"text":" and ","type":"text"},{"inlineContent":[{"text":"semantic tokens","type":"text"}],"type":"emphasis"},{"type":"text","text":" using in the end "},{"inlineContent":[{"type":"text","text":"raw tokens"}],"type":"emphasis"},{"type":"text","text":"."},{"text":" ","type":"text"},{"type":"text","text":"A "},{"inlineContent":[{"type":"text","text":"theme"}],"type":"emphasis"},{"text":" contains any relevant ","type":"text"},{"type":"emphasis","inlineContent":[{"text":"semantic tokens","type":"text"}]},{"type":"text","text":" and "},{"type":"emphasis","inlineContent":[{"text":"component tokens","type":"text"}]},{"type":"text","text":" which can be used for components rendering."},{"type":"text","text":" "},{"type":"text","text":"A "},{"type":"emphasis","inlineContent":[{"text":"theme","type":"text"}]},{"type":"text","text":" has also "},{"type":"emphasis","inlineContent":[{"type":"text","text":"raw tokens"}]},{"type":"text","text":" associated to primitive types so as to give to "},{"type":"emphasis","inlineContent":[{"type":"text","text":"components"}]},{"type":"text","text":", written with "},{"type":"emphasis","inlineContent":[{"type":"text","text":"SwiftUI"}]},{"text":", the needed values in the suitable type. A ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"theme"}]},{"text":" can add for itself any new ","type":"text"},{"inlineContent":[{"type":"text","text":"tokens"}],"type":"emphasis"},{"type":"text","text":"."}],"kind":"article","identifier":"doc:\/\/OUDS\/documentation\/OUDS\/Themes"},"doc://OUDS/documentation/OUDS/Tokens":{"title":"Tokens","identifier":"doc:\/\/OUDS\/documentation\/OUDS\/Tokens","abstract":[{"type":"text","text":"Design tokens represent the small, repeated design decisions that make up a design system’s visual style. Tokens replace hard-coded static values, such as hexadecimal codes for color, with self-explanatory names."}],"role":"article","kind":"article","type":"topic","url":"\/documentation\/ouds\/tokens"},"doc://OUDS/documentation/OUDS/Modules":{"kind":"article","url":"\/documentation\/ouds\/modules","identifier":"doc:\/\/OUDS\/documentation\/OUDS\/Modules","title":"Modules","abstract":[{"text":"A ","type":"text"},{"type":"emphasis","inlineContent":[{"text":"module","type":"text"}]},{"type":"text","text":" can be seen as a set of features and components to fill a need."},{"type":"text","text":" "},{"text":"There is not module yet.","type":"text"}],"type":"topic","role":"article"}}} | ||
{"abstract":[{"type":"emphasis","inlineContent":[{"type":"text","text":"Components"}]},{"type":"text","text":" are defined in the "},{"isActive":true,"type":"reference","identifier":"https:\/\/ios.unified-design-system.orange.com\/documentation\/oudstokenscomponent\/"},{"type":"text","text":" target and can be integrated in applications."}],"primaryContentSections":[{"content":[{"anchor":"overview","text":"Overview","type":"heading","level":2},{"inlineContent":[{"type":"text","text":"❗**More details coming soon.**❗"}],"type":"paragraph"},{"type":"heading","text":"How to use components","anchor":"How-to-use-components","level":2},{"inlineContent":[{"type":"text","text":"Import the target of components, and use the component you want:"}],"type":"paragraph"},{"code":["import OUDSComponents \/\/ To get the components"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"Of course you must use in your root view the "},{"type":"reference","identifier":"doc:\/\/ouds-ios.OUDS\/documentation\/OUDS\/OUDSThemeableView","isActive":true},{"text":" with the suitable theme:","type":"text"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":[" \/\/ The theme can be OrangeTheme or your own"," OUDSThemeableView(theme: theTheme) {"," "," }"]}],"kind":"content"}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/ouds-ios.OUDS\/documentation\/OUDS"]]},"seeAlsoSections":[{"title":"Essentials","anchor":"Essentials","identifiers":["doc:\/\/ouds-ios.OUDS\/documentation\/OUDS\/GettingStarted","doc:\/\/ouds-ios.OUDS\/documentation\/OUDS\/Tokens","doc:\/\/ouds-ios.OUDS\/documentation\/OUDS\/Themes","doc:\/\/ouds-ios.OUDS\/documentation\/OUDS\/Modules"],"generated":true}],"metadata":{"modules":[{"name":"OUDS"}],"title":"Components","role":"article","roleHeading":"Article"},"variants":[{"paths":["\/documentation\/ouds\/components"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/ouds-ios.OUDS\/documentation\/OUDS\/Components"},"kind":"article","references":{"doc://ouds-ios.OUDS/documentation/OUDS/Themes":{"url":"\/documentation\/ouds\/themes","role":"article","abstract":[{"inlineContent":[{"text":"Themes","type":"text"}],"type":"emphasis"},{"type":"text","text":" are applications of specific values for "},{"inlineContent":[{"text":"components tokens","type":"text"}],"type":"emphasis"},{"type":"text","text":" and "},{"inlineContent":[{"text":"semantic tokens","type":"text"}],"type":"emphasis"},{"text":" using in the end ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"raw tokens"}]},{"text":".","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"A "},{"inlineContent":[{"text":"theme","type":"text"}],"type":"emphasis"},{"type":"text","text":" contains any relevant "},{"type":"emphasis","inlineContent":[{"type":"text","text":"semantic tokens"}]},{"text":" and ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"component tokens"}]},{"type":"text","text":" which can be used for components rendering."},{"type":"text","text":" "},{"text":"A ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"theme"}]},{"text":" has also ","type":"text"},{"type":"emphasis","inlineContent":[{"text":"raw tokens","type":"text"}]},{"text":" associated to primitive types so as to give to ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"components"}]},{"text":", written with ","type":"text"},{"type":"emphasis","inlineContent":[{"text":"SwiftUI","type":"text"}]},{"text":", the needed values in the suitable type. A ","type":"text"},{"inlineContent":[{"text":"theme","type":"text"}],"type":"emphasis"},{"text":" can add for itself any new ","type":"text"},{"inlineContent":[{"text":"tokens","type":"text"}],"type":"emphasis"},{"text":".","type":"text"}],"kind":"article","identifier":"doc:\/\/ouds-ios.OUDS\/documentation\/OUDS\/Themes","type":"topic","title":"Themes"},"doc://ouds-ios.OUDS/documentation/OUDS":{"abstract":[{"type":"text","text":"The iOS library of "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Orange Unified Design System Design System"}]},{"text":", the new design system unified and cohesive across all platforms to build Orange mobile applications.","type":"text"}],"identifier":"doc:\/\/ouds-ios.OUDS\/documentation\/OUDS","title":"OUDS","url":"\/documentation\/ouds","type":"topic","kind":"symbol","role":"collection"},"doc://ouds-ios.OUDS/documentation/OUDS/OUDSThemeableView":{"role":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"OUDSThemeableView"}],"abstract":[{"text":"This is a kind of root ","type":"text"},{"type":"codeVoice","code":"SwiftUI.View"},{"text":" to add at the top level of your views tree so as to define","type":"text"},{"type":"text","text":" "},{"text":"as an environement variable the theme which will be applied.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Any theme to apply must be a child of "},{"code":"OUDSTheme","type":"codeVoice"},{"type":"text","text":", direct or not."}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"OUDSThemeableView"}],"title":"OUDSThemeableView","url":"\/documentation\/ouds\/oudsthemeableview","identifier":"doc:\/\/ouds-ios.OUDS\/documentation\/OUDS\/OUDSThemeableView"},"doc://ouds-ios.OUDS/documentation/OUDS/Modules":{"title":"Modules","url":"\/documentation\/ouds\/modules","abstract":[{"text":"A ","type":"text"},{"inlineContent":[{"type":"text","text":"module"}],"type":"emphasis"},{"type":"text","text":" can be seen as a set of features and components to fill a need."},{"type":"text","text":" "},{"text":"There is not module yet.","type":"text"}],"type":"topic","kind":"article","role":"article","identifier":"doc:\/\/ouds-ios.OUDS\/documentation\/OUDS\/Modules"},"doc://ouds-ios.OUDS/documentation/OUDS/Tokens":{"url":"\/documentation\/ouds\/tokens","role":"article","abstract":[{"type":"text","text":"Design tokens represent the small, repeated design decisions that make up a design system’s visual style. Tokens replace hard-coded static values, such as hexadecimal codes for color, with self-explanatory names."}],"kind":"article","identifier":"doc:\/\/ouds-ios.OUDS\/documentation\/OUDS\/Tokens","type":"topic","title":"Tokens"},"doc://ouds-ios.OUDS/documentation/OUDS/GettingStarted":{"type":"topic","kind":"article","identifier":"doc:\/\/ouds-ios.OUDS\/documentation\/OUDS\/GettingStarted","url":"\/documentation\/ouds\/gettingstarted","abstract":[{"type":"text","text":"How to add the package as dependency, and import libraries"}],"title":"Getting Started with OUDS","role":"article"}}} |
Oops, something went wrong.