Skip to content

About

🍜 A Swift Package of SwiftUI components and tools soup πŸ™

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Β 
Β 

Latest commit

Β 

History

1,249 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Logo of MISO tool

MISO iOS

🍜 MISO is a library of SwiftUI components (forked from ouds-ios), themes and tools for iOS app development.
πŸ™ Miso Is So {Open | Obvious | Original | Or not}
Report bug Β· Wiki Β· Demo app Β· Documentation

Build and test status Β  SwiftPolyglot status Β  SwiftLint status

βš™οΈ Status

MIT license

Versions Still maintained

Code size Opened issues

iOS 15 iPadOS 15 macOS 13 visionOS 1 watchOS 11 tvOS 16

[Xcode 27.1

ℹ️ About MISO

MISO is a recursive acronym which can mean for example Miso Is So Open. Or Obvious. Or Original. We don't care in the end. Miso soup is also tasty. 🍜

Caution

This Swift Package is dedicated to SwiftUI. UIKit and other frameworks are not supported.

Note

Main targets are iOS / iPadOS, and we do our best to support macOS, visionOS, tvOS and watchOS!

πŸš€ Quick start

Tip

Documentation on GitHub Pages will come soon.

Choose your version

You can find available releases on GitHub releases.

Add the dependency (Swift Package Manager)

First, you must add as package dependency of your project the URL of this Swift Package GitHub repository:

https://github.com/pylapp/miso-ios

You can choose the dependency rule you want. Keep in mind MISO iOS releases are frozen and are based on semantic versioning.

In your Xcode targets, add the libraries you need. Everything is splitted so as to let users choose the content to embed they want.

Add the dependency (XCFramework)

Get the XCFramework ZIP file from the GitHub releases of the version you want. Uncompress the ZIP, and if you want check its checksum or cryptographic signature. Otherwise uncompress the XCFramework ZIP, and drag and drop all the XCFrameworks (~10) in your Xcode project. Associate them to the target(s) you want. And, in your source code, when you use MISO items, import MISOSwiftUI.

Note

XCFramework is not the prefered solution to use MISO Thus the XCFramework available are tailored for iOS platform. For more evolutions feel free to contact the maintainers.

Instanciate and inject theme

In the root view of your app, add the MISOThemeableView with inside the theme object you want to apply. You can instanciate the theme object on the fly, but only once.

@main
struct YourApp: App {

    var body: some Scene {
        WindowGroup {
            MISOThemeableView(theme: theTheme) {
              AppRootView() // Add your app root view here
            }
        }
    }
}

Get the theme

If you need to get configuration details from the theme (colors, dimensions, etc.), get the theme through environment object:

  @Environment(\.theme) var theme

πŸ“¦ Content

Tip

Releases are immutable and in most of time cryptographically signed (commits, tags and artifacts). You can verify their integrity with commands from GPG tool of GitHub CLI client.

πŸ“¦ Binary distribution (XCFramework)

In addition to the standard Swift Package distribution, MISO is also published as a dynamic XCFramework for the MISOSwiftUI umbrella product This distribution is intended to solve the duplication / symbol-conflict problem that appears when several third-party XCFrameworks each embed their own copy of MISO in the same application.

Unzip the XCFramework archive, add all ~10 XCFrameworks to your Xcode project, embed and sign only MISOSwiftUI, and import that dependency.

πŸͺ² Bugs, feature requests and discussions

Have a bug or a component request? Please first search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

If you want to share ideas or discuss about API, features, components or other topics, you should first open a new discussion. Q&A is more dedicated for help, otherwise feel free to open or update a topic in Ideas. Keep in mind internal or sensitive discussions must be in internal tools, not public ones.

If your discussions, requests or issues are about the demo application, use instead its GitHub project.

🀝 Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development. More technical details are available also in the DEVELOP file.

πŸ”’ Data and privacy

The MISO is a Software Development Kit (SDK) that helps developers to create mobile applications more easily and quickly with predefined components and tools. As such:

  • this SDK does not handle any personal data
  • this SDK does not require any device permission to work

βš–οΈ Copyright and license

Important

This project is a fork from Orange-OpenSource/ouds-ios, but with a lot of refactoring to make the product lighter and not locked by proprietary or branded assets. MISO does not replace OUDS, and does not belong to Orange Group. The MIT license of MISO comes from OUDS MIT license.

Code released under the MIT License. Images, illustrations and videos are under CC0 1.0 Universal

Note

Copyright Orange SA (for OUDS specific elements)

Note

Copyright Pierre-Yves Lapersonne (for MISO)

About

🍜 A Swift Package of SwiftUI components and tools soup πŸ™

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages