{"id":19153842,"url":"https://github.com/enryun/tutorialkit","last_synced_at":"2025-09-15T20:09:10.924Z","repository":{"id":232862774,"uuid":"782822877","full_name":"Enryun/TutorialKit","owner":"Enryun","description":"TutorialKit help developers create interactive tutorial experience for iOS applications","archived":false,"fork":false,"pushed_at":"2024-05-15T17:02:44.000Z","size":310,"stargazers_count":9,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-12T16:37:19.885Z","etag":null,"topics":["ios","swift","tutorial","uikit"],"latest_commit_sha":null,"homepage":"https://www.linkedin.com/in/jamesthang/","language":"Objective-C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Enryun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-06T06:10:38.000Z","updated_at":"2025-05-20T12:37:03.000Z","dependencies_parsed_at":"2024-04-30T17:48:49.589Z","dependency_job_id":"e5003cea-c4e5-4e5c-8dd8-1e7bcc816738","html_url":"https://github.com/Enryun/TutorialKit","commit_stats":null,"previous_names":["enryun/tutorialkit"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/Enryun/TutorialKit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Enryun%2FTutorialKit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Enryun%2FTutorialKit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Enryun%2FTutorialKit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Enryun%2FTutorialKit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Enryun","download_url":"https://codeload.github.com/Enryun/TutorialKit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Enryun%2FTutorialKit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275312979,"owners_count":25442566,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-15T02:00:09.272Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ios","swift","tutorial","uikit"],"created_at":"2024-11-09T08:24:31.177Z","updated_at":"2025-09-15T20:09:10.860Z","avatar_url":"https://github.com/Enryun.png","language":"Objective-C","readme":"# TutorialKit\n\n![iOS 12.0+](https://img.shields.io/badge/iOS-12.0%2B-blue.svg)\n[![Pod Version](http://img.shields.io/cocoapods/v/SDWebImage.svg?style=flat)](https://cocoapods.org/pods/Tutorials)\n[![Swift Package Manager](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://mit-license.org)\n\n## Table of Contents\n1. [Overview](#overview)\n2. [Requirements](#requirements)\n3. [Installation](#installation)\n4. [Features](#features)\n5. [Usage](#usage)\n6. [Author](#author)\n\n## Overview\n\n`TutorialKit` help developers create interactive tutorial experience for iOS applications. Utilizing `TutorialViewController`, it showcases step-by-step guides with dynamic content including text, images, and highlighted areas.\n\n\u003cimg src=\"https://github.com/Enryun/TutorialKit/assets/45484154/7ddce1ee-6783-4a55-9197-26e1abbce29a\" width=\"200\"\u003e\n\u003cimg src=\"https://github.com/Enryun/TutorialKit/assets/45484154/a53fd5a3-1a92-4a42-b5e1-4645345e92aa\" width=\"200\"\u003e\n\u003cimg src=\"https://github.com/Enryun/TutorialKit/assets/45484154/ffdd0bf3-5f98-49d3-b98b-9de65b9950e8\" width=\"200\"\u003e\n\n## Requirements\n\n| Platform | Minimum Version |\n|----------|-----------------|\n| iOS      | 12.0            |\n\n ## Installation\nThis project can be installed using `Swift Package Manager` and `CocoaPod`.\n\n### Swift Package Manager\n\n1. Open your project in Xcode.\n2. Navigate to `File` \u003e `Swift Packages` \u003e `Add Package Dependency`.\n3. Paste the repository URL: `https://github.com/Enryun/TutorialKit`\n4. Follow the prompts to add the package to your project.\n\nFor more details on using Swift Package Manager, visit [Apple's Swift Package Manager documentation](https://swift.org/package-manager/).\n\n### CocoaPods\n\n[CocoaPods](http://cocoapods.org/) is a dependency manager for Objective-C, which automates and simplifies the process of using 3rd-party libraries in your projects. See the [Get Started](http://cocoapods.org/#get_started) section for more details.\n\nAdd the following entry to your Podfile:\n\n```rb\npod 'Tutorials', '~\u003e 1.1.3'\n```\n\nThen run `pod install`.\n\nDon't forget to `import TutorialKit` in every file you'd like to use it.\n\n## Features\n- Customizable tutorial steps with `Tutorial` structs.\n- Support for light/dark mode with `BackgroundColor`.\n- Interactive elements like `TutorialContent` for engaging tutorials.\n- Flexible alignment and positioning with `TutorialAlignment`.\n\n## Usage\n\n### 5.1. Import `TutorialKit` into your view controller:\n\n```swift\nimport TutorialKit\n```\n\n### 5.2. Configure the tutorial appearance by creating an instance of `TutorialConfiguration`:\n\nDefines the overall look, feel, and behavior of the tutorial experience. Allows developers to tailor the tutorial component to seamlessly fit within the aesthetic and functional aspects of their app.\n\n```swift\nlet configuration = TutorialConfiguration(\n            title: .init(font: .systemFont(ofSize: 24, weight: .semibold), textColor: .label),\n            description: .init(font: .systemFont(ofSize: 16, weight: .regular), textColor: .label),\n            backgroundColor: BackgroundColor(ligtModeColor: .init(color: .systemYellow, opacity: 0.7), darkModeColor: .init(color: .systemGreen, opacity: 0.3)),\n            sound: .tap,\n            alignment: .bottom\n        )\n```\n\nYou can customize the title, description, background color, sound, and alignment:\n- `title` and `description`: Customize fonts, sizes, and colors for titles and descriptions that later set up with `Tutorial`.\n- `backgroundColor`: Set different colors and opacities for the tutorial overlay layer, with distinct settings for light and dark modes.\n- `sound`: Choose a sound effect for interactive elements within the tutorial, enhancing the user experience.\n- `alignment` here is Global Alignment: Specifies the default alignment for tutorial steps, with the option for individual steps to override this setting later when configure individual `Tutorial`.\n\n### 5.3. Configure the Tutorial Data:\n\nPrepare the data for each tutorial step by creating instances of `Tutorial`. Each instance can include a title, description(s), alignment, and a defined transparent area.\n\n```swift\nlet tutorials = [\n    Tutorial(\n        title: .init(\n            text: \"Study Category\",\n            image: UIImage(systemName: \"heart\")?\n                .withRenderingMode(.alwaysOriginal)\n                .withTintColor(.label)\n        ),\n        description: [\n            .init(\n                text: \"group common things together\",\n                image: UIImage(systemName: \"lightbulb.circle\")?\n                    .withRenderingMode(.alwaysOriginal)\n                    .withTintColor(.label)\n            ),\n            .init(\n                text: \"Ex: Lessons from the same Subject\",\n                image: UIImage(systemName: \"lightbulb.circle\")?\n                    .withRenderingMode(.alwaysOriginal)\n                    .withTintColor(.label)\n            )\n        ],\n        alignment: .center,\n        transparentArea: .init(x: 100, y: 100, width: 150, height: 150, cornerRadius: 0)\n    )\n    // Add more Tutorial instances as needed.\n]\n```\nResult: \n\n\u003cimg src=\"https://github.com/Enryun/TutorialKit/assets/45484154/133745b6-b28f-498d-b6ab-0c91bf8fa6f0\" width=\"200\"\u003e\n\n\n- `title`: The main heading of a tutorial step, optionally accompanied by an image to illustrate the concept.\n- `description`: Detailed information or instructions for the tutorial step, which can also include images for a more engaging presentation.\n- `alignment`: Determines the screen position of the tutorial content, aiding in highlighting various UI elements.\n- `transparentArea`: Defines a specific area of the screen to remain visible and interactive, focusing the user's attention on certain actions or features.\n\n### 5.4.  Initialize and Present the TutorialViewController:\n\nCreate an instance of TutorialViewController with your data and configuration, then present it.\n\n```swift\nlet vc = TutorialViewController(data: tutorials, configuration: configuration)\nvc.showTutorials()\npresent(vc, animated: true)\n```\n\nThat's it. When finished navigate through the data array, `TutorialViewController` will automatically be removed.\n\n## Author\nJames Thang, find me on [LinkedIn](https://www.linkedin.com/in/jamesthang/)\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenryun%2Ftutorialkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fenryun%2Ftutorialkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenryun%2Ftutorialkit/lists"}