Skip to content

Companion app and XCode extension for adding SwiftUI recipes to your code.

License

Notifications You must be signed in to change notification settings

globulus/swiftui-recipes-companion

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

81 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SwiftUI Recipes Companion

Free Companion app and XCode extension for adding SwiftUI recipes to your code.

Choose from a rich selection of SwiftUI recipes, that range from simple tasks to entire custom components:

Companion App

Then, simply insert their code straight into yours via the Editor menu:

Companion App

Be sure to check out the online version as well!

Installation

  • Download and install the app from the App Store.
  • Run the companion app first (search Applications -> SwiftUI Recipes). It'll fetch the list of recipes from Github and allow you to preview their content/code and exclude those you don't want in your Editor menu. After you're done, be sure to press the Save button.
  • Go to System Preferences -> Extensions -> Xcode Source Editor -> Check Helper (with SwiftUI Recipes app icon).
  • Run Xcode (or restart if it was open) and go to Editor -> Recipes -> .... Pressing any recipe command will insert its code at your cursor. There's also the special Run Companion command that will start the companion app again.

Usage

Companion App:

  • The list of recipes will be fetched automatically, but you can pull it again with Refresh.
  • Click the recipe to see its details, image and code.
  • Checkmark on left-hand side means that the recipe will show up in your XCode Extension. If you click it, it turns into a red X and then the recipe is excluded.
  • Click Save to store the recipes locally to that the XCode extension can use them.
  • Regularly check for new recipes, as new ones are added on a daily basis.

Source Editor Extension:

  • Open a project and one of its source files.
  • Go to the menu, Editor -> Recipes -> .. and select a recipe to insert its code at your cursor.
  • Click Editor -> Recipes -> Run Companion to open the companion app again. If you make any changes in the companion app, you'll have to restart XCode for the changes to take effect.

Contributing Recipes

All the recipes are open source and live in the Recipes folder in the Git.

Any contributions are more than welcome! Let's grow the cookbook together!

To contribute a recipe, simply create a PR with a new recipe file. A recipe file is a yml with the following structure:

---
title: "Title of the recipe, as it'll appear in the App/Extension. Can only contain slash / and parentheses () as special characters."
description: "Give a short description of the recipe here."
author: "Your name or email address."
url: "Optional, URL to more details on the subject."
image: "Optional, URL to the image accompanying the recipe. Feel free to include the image in the PR."
updatedAt: "ISO-formatted timestamp of the latest recipe update."
minSwiftUIVersion: Minimum SwiftUI version that supports the recipe, e.g 1, 2, 3
maxSwiftUIVersion: Optional, if the recipe got deprecated in a newer SwiftUI version.
---
RECIPE CODE GOES HERE

Blog

Check out SwiftUIRecipes.com for in-depth explanations of common, yet puzzling SwiftUI tasks.

About

Companion app and XCode extension for adding SwiftUI recipes to your code.

Resources

License

Stars

Watchers

Forks

Packages

No packages published