A comprehensive recipe FieldType for Craft CMS that includes metric/imperial conversion, portion calculation, and JSON-LD microdata support
Switch branches/tags
Nothing to show
Clone or download
khalwat Updated README.md
Signed-off-by: Andrew Welch <andrew@nystudio107.com>
Latest commit 8f0e6a1 Mar 20, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
resources Updated icon! Dec 12, 2017
src Fixed deprecation errors from Craft CMS 3 RC13 Mar 2, 2018
CHANGELOG.md Version 1.0.7 Mar 2, 2018
LICENSE.md Updated to MIT license Nov 25, 2017
README.md Updated README.md Mar 20, 2018
composer.json Version 1.0.7 Mar 2, 2018

README.md

Scrutinizer Code Quality Code Coverage Build Status Code Intelligence Status

Recipe plugin for Craft CMS 3.x

A comprehensive recipe FieldType for Craft CMS that includes metric/imperial conversion, portion calculation, and JSON-LD microdata support

Screenshot

Related: Recipe for Craft 2.x

Requirements

This plugin requires Craft CMS 3.0.0-RC1 or later.

Installation

To install Recipe, follow these steps:

  1. Install with Composer via composer require nystudio107/craft-recipe
  2. Install plugin in the Craft Control Panel under Settings > Plugins

You can also install Recipe via the Plugin Store in the Craft AdminCP.

Recipe works on Craft 3.x.

Recipe Overview

Screenshot

Recipe adds a 'Recipe' FieldType for Craft CMS that you can add to any of your Sections.

In encapsulates everything you need for a recipe, including the ingredients, a photo of the recipe, directions, cooking time, ratings, and even nutritional information. It handles converting between Imperial and Metric units, outputs 'pretty' fractions for Imperial units, and can output correct ingredient portions for any number of servings.

Recipe also generates the JSON-LD microdata for your recipes, which allows it to be displayed in the Google knowledge panel for search results.

We hope Recipe makes it easier for you to create and share some yummy recipes!

Configuring Recipe

Create a Recipe field via Settings->Fields and you can set the Asset Sources that are used for the recipe images

Using Recipe

Once you have created the Recipe field, add it to your Section Entry Types, and fill in what recipe information is appropriate. Nothing other than the name is required, so feel free to leave anything blank that you're not using.

Using Recipe in your Templates

To display information about a recipe in your templates, you just use familiar Twig code. Let's assume the field handle for your Recipe field is someRecipe; this is what you'd use to output information about it:

Basic Info

  • {{ entry.someRecipe.name }} - the name of the recipe
  • {{ entry.someRecipe.description }} - the description of the recipe
  • {{ entry.someRecipe.skill }} - the skill level required to make this recipe
  • {{ entry.someRecipe.serves }} - how many people the recipe serves
  • {{ entry.someRecipe.getImageUrl() }} - a URL to the image for the recipe
  • {{ entry.someRecipe.prepTime }} - the prep time for the recipe in minutes
  • {{ entry.someRecipe.cookTime }} - the cooking time for the recipe in minutes
  • {{ entry.someRecipe.totalTime }} - the total time for the recipe in minutes

Ingredients

For a list of ingredients, do the following (adding whatever output markup you want):

{% set ingredients = entry.someRecipe.getIngredients('imperial', 1) %}
{% for ingredient in ingredients %}
    {{ ingredient }}
{% endfor %}

The first parameter is the units you'd like to use ('imperial' or 'metric'). The second parameter is how many people you'd like the recipe portions to be sized for. By default, it will use 'imperial' and the serving size in the recipe if you don't pass these parameters in, e.g.: entry.someRecipe.getIngredients()

Directions

For a list of directions, do the following (adding whatever output markup you want):

{% set directions = entry.someRecipe.getDirections() %}
{% for direction in directions %}
    {{ direction }}
{% endfor %}

Ratings

For a list of the ratings, do the following (adding whatever output markup you want):

{% set ratings = entry.someRecipe.ratings %}
{% for rating in ratings %}
    {{ rating.rating }} {{ rating.review }} {{ rating.author }}
{% endfor %}

For the aggregate (average) rating for this recipe, do the following (adding whatever output markup you want):

{{ entry.someRecipe.getAggregateRating() }}

Nutritional Information

To output the nutritional information for the recipe, do the following:

  • {{ entry.someRecipe.servingSize }} - The serving size, in terms of the number of volume or mass
  • {{ entry.someRecipe.calories }} - The number of calories per serving
  • {{ entry.someRecipe.carbohydrateContent }} - The number of grams of carbohydrates per serving
  • {{ entry.someRecipe.cholesterolContent }} - The number of milligrams of cholesterol per serving
  • {{ entry.someRecipe.fatContent }} - The number of grams of fat per serving
  • {{ entry.someRecipe.fiberContent }} - The number of grams of fiber per serving
  • {{ entry.someRecipe.proteinContent }} - The number of grams of protein per serving
  • {{ entry.someRecipe.saturatedFatContent }} - The number of grams of saturated fat per serving
  • {{ entry.someRecipe.sodiumContent }} - The number of milligrams of sodium per serving
  • {{ entry.someRecipe.sugarContent }} - The number of grams of sugar per serving
  • {{ entry.someRecipe.transFatContent }} - The number of grams of trans fat per serving
  • {{ entry.someRecipe.unsaturatedFatContent }} - The number of grams of unsaturated fat per serving

Image Asset ID

If you need to do any further manipulation of the Recipe Image (perhaps a transform) you can get the Asset ID for it:

  • {{ entry.someRecipe.imageId }} - the Asset ID of the image for the recipe

Rendering Recipe JSON-LD Microdata

Recipe can render JSON-LD microdata for you, which allows it to be displayed in the Google knowledge panel for search results:

{{ entry.someRecipe.renderRecipeJSONLD() }}

Screenshot

Recipe Roadmap

Some things to do, and ideas for potential features:

  • Provide a front-end way to add ratings

Brought to you by nystudio107