jcdcdev.Umbraco.ReadingTime 10.0.0-alpha0001

This is a prerelease version of jcdcdev.Umbraco.ReadingTime.
There is a newer version of this package available.
See the version list below for details.
dotnet add package jcdcdev.Umbraco.ReadingTime --version 10.0.0-alpha0001
                    
NuGet\Install-Package jcdcdev.Umbraco.ReadingTime -Version 10.0.0-alpha0001
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="jcdcdev.Umbraco.ReadingTime" Version="10.0.0-alpha0001" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="jcdcdev.Umbraco.ReadingTime" Version="10.0.0-alpha0001" />
                    
Directory.Packages.props
<PackageReference Include="jcdcdev.Umbraco.ReadingTime" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add jcdcdev.Umbraco.ReadingTime --version 10.0.0-alpha0001
                    
#r "nuget: jcdcdev.Umbraco.ReadingTime, 10.0.0-alpha0001"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package jcdcdev.Umbraco.ReadingTime@10.0.0-alpha0001
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=jcdcdev.Umbraco.ReadingTime&version=10.0.0-alpha0001&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=jcdcdev.Umbraco.ReadingTime&version=10.0.0-alpha0001&prerelease
                    
Install as a Cake Tool

jcdcdev.Umbraco.ReadingTime

Umbraco Version GitHub license NuGet Downloads

Custom Data Type for calculating reading time. With full variant support!

The following editors are currently supported:

  • Rich Text
  • Markdown
  • Block Grid
  • Block List
  • Nested Content
  • Textstring
  • Textarea

Quick Start

  1. Install the NuGet package in your Umbraco CMS website project.

     dotnet add package jcdcdev.Umbraco.ReadingTime
    
  2. Add the Reading Time data type to a document type. You can configure:

    • Words per minute (default is 200)
    • Min Unit (default is Minute)
    • Max Unit (default is Minute) A screenshot of the BackOffice showing Reading Time data type
  3. Save and publish content.

  4. Reading Time will display in the backoffice

    A screenshot of the BackOffice showing Reading Time

Using the value in your templates

In your template, you can accessing the Reading Time property value like any other property:

 @Model.ReadingTime.DisplayTime()

A screenshot of page showing Reading Time

Overriding the default display

The DisplayTime method will format the reading time as a string using Humanizer. This supports variants, meaning the reading time will be displayed based on the pluralisation rules of the current culture (e.g. "1 minute", "2 minutes", "0 minuter").

Min and max TimeUnit values are derived from the Data Type settings. The below example shows how you can ensure only seconds are displayed.

 Model.ReadingTime.DisplayTime(minUnit: TimeUnit.Second, maxUnit: TimeUnit.Second)

Configuration

You can change the average words per minute in the data type settings.

When creating a new data type, the default will be 200 words per minute. To change this default, adjust your appsettings.json file:

{
  "ReadingTime": {
    "WordsPerMinute": 200
  }
}

Limitations

Values are derived from published content only.

Draft content is not included in the calculation.

Words per minute applies to all variants.

It is not currently possible to configure words per minute per culture.

Extending

You can extend the data type to support additional editors by implementing the IReadingTimeValueProvider interface.

public class MyCustomReadingTimeValueProvider : IReadingTimeValueProvider
{
    public bool CanConvert(IPropertyType type)
    {
        return type.EditorAlias == "MyCustomEditorAlias";
    }

    public TimeSpan? GetReadingTime(IProperty property, string? culture, string? segment, IEnumerable<string> availableCultures, ReadingTimeConfiguration config)
    {
        var value = property.GetValue(culture, segment, true);
        if (value is string text)
        {
            return text.GetReadingTime(config.WordsPerMinute);
        }

        return null;
     }
 }

Don't forget to register your custom value provider:

public class Composer : IComposer
{
    public void Compose(IUmbracoBuilder builder)
    {
        builder.ReadingTimeValueProviders().Append<MyCustomReadingTimeValueProvider>();
    }
}

Contributing

Contributions to this package are most welcome! Please read the Contributing Guidelines.

Acknowledgments (thanks!)

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
16.0.1 91 7/27/2025
16.0.1-alpha0009 133 7/9/2025
16.0.0 392 6/12/2025
16.0.0-alpha0008 283 6/12/2025
16.0.0-alpha0005 280 6/10/2025
16.0.0-alpha0002 186 5/11/2025
15.0.14 88 7/27/2025
15.0.14-alpha0003 112 7/16/2025
15.0.13 136 7/3/2025
15.0.13-alpha0003 95 6/22/2025
15.0.12 188 6/16/2025
15.0.12-alpha0007 136 6/16/2025
15.0.12-alpha0001 139 6/3/2025
15.0.11 141 6/1/2025
15.0.11-alpha0017 135 6/1/2025
15.0.11-alpha0009 133 6/1/2025
15.0.11-alpha0003 141 5/27/2025
15.0.10 195 5/11/2025
15.0.10-alpha0011 151 5/8/2025
15.0.9 222 4/22/2025
15.0.9-alpha0003 164 4/21/2025
15.0.8 164 4/18/2025
15.0.8-alpha0008 244 4/13/2025
15.0.8-alpha0003 152 4/6/2025
15.0.7 222 3/30/2025
15.0.7-alpha0019 130 3/30/2025
15.0.7-alpha0010 149 3/23/2025
15.0.7-alpha0008 153 3/23/2025
15.0.7-alpha0003 148 3/18/2025
15.0.6 195 3/12/2025
15.0.6-alpha0003 163 3/10/2025
15.0.5 219 3/7/2025
15.0.5-alpha0003 202 3/4/2025
15.0.4 157 3/3/2025
15.0.4-alpha0003 107 2/24/2025
15.0.3 116 2/19/2025
15.0.3-alpha0005 87 2/16/2025
15.0.3-alpha0003 84 2/16/2025
15.0.2 106 2/13/2025
15.0.2-alpha0004 102 2/10/2025
15.0.1 129 2/7/2025
15.0.1-alpha0005 92 2/6/2025
15.0.0 181 11/19/2024
15.0.0-alpha0012 93 11/17/2024
15.0.0-alpha0010 98 11/12/2024
15.0.0-alpha0006 92 10/23/2024
15.0.0-alpha0004 83 10/17/2024
15.0.0-alpha0003 80 10/17/2024
15.0.0-alpha0001 115 10/9/2024
14.0.6 148 6/1/2025
14.0.6-alpha0015 136 5/27/2025
14.0.6-alpha0006 143 5/8/2025
14.0.5 152 4/22/2025
14.0.5-alpha0005 165 4/22/2025
14.0.4 199 10/8/2024
14.0.4-alpha0003 87 10/31/2024
14.0.3 119 9/27/2024
14.0.3-alpha0013 98 9/26/2024
14.0.2 129 9/23/2024
14.0.2-alpha0005 107 9/22/2024
14.0.1 152 7/4/2024
14.0.1-alpha0010 110 7/1/2024
14.0.1-alpha0003 97 6/24/2024
14.0.0 133 6/6/2024
14.0.0-alpha0008 111 6/6/2024
14.0.0-alpha0005 110 6/6/2024
14.0.0-alpha0003 110 6/4/2024
14.0.0-alpha0001 102 5/25/2024
13.0.6 84 7/27/2025
13.0.6-alpha0009 110 7/16/2025
13.0.5 296 6/12/2025
13.0.5-alpha0013 135 6/3/2025
13.0.5-alpha0006 220 5/12/2025
13.0.4 400 4/23/2025
13.0.4-alpha0002 158 4/21/2025
13.0.3 359 3/30/2025
13.0.3-alpha0003 139 3/18/2025
13.0.2 2,995 10/28/2024
13.0.2-alpha0008 90 10/23/2024
13.0.1 1,550 5/25/2024
13.0.0 148 5/25/2024
13.0.0-alpha0001 105 5/25/2024
12.0.2 140 6/16/2025
12.0.1 117 5/25/2024
12.0.0 121 5/25/2024
12.0.0-alpha0001 111 5/25/2024
10.0.5 279 6/12/2025
10.0.5-alpha0015 133 6/2/2025
10.0.5-alpha0007 209 5/12/2025
10.0.4 155 3/30/2025
10.0.4-alpha0003 153 3/30/2025
10.0.3 100 1/29/2025
10.0.2 111 10/28/2024
10.0.2-alpha0030 91 10/23/2024
10.0.2-alpha0018 117 9/29/2024
10.0.2-alpha0008 91 9/29/2024
10.0.1 129 5/25/2024
10.0.0 124 5/25/2024
10.0.0-alpha0001 119 5/25/2024
0.3.1 941 4/5/2024
0.3.0 167 4/2/2024
0.2.0 164 3/31/2024
0.1.1 613 1/8/2024
0.1.0 145 1/8/2024