jcdcdev.Umbraco.ReadingTime 0.1.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package jcdcdev.Umbraco.ReadingTime --version 0.1.0
                    


                    

                
NuGet\Install-Package jcdcdev.Umbraco.ReadingTime -Version 0.1.0
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="0.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="jcdcdev.Umbraco.ReadingTime" Version="0.1.0" />
                    


                            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 0.1.0
                    


                    

                
#r "nuget: jcdcdev.Umbraco.ReadingTime, 0.1.0"
#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@0.1.0
#: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=0.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=jcdcdev.Umbraco.ReadingTime&version=0.1.0
                    


                            Install as a Cake Tool

jcdcdev.Umbraco.ReadingTime

Umbraco Version NuGet GitHub license Downloads

Custom Data Type for calculating reading time.

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.
  2. Add the Reading Time data type to a document type.
    • Note: You can configure the words per minute in the data type settings.
  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.

<div class="alert alert-info">
    Read in @Model.ReadingTime.DisplayTime()
</div>

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.

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 is compatible.  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 is compatible.  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-alpha0009 128 7/9/2025
16.0.0 336 6/12/2025
16.0.0-alpha0008 281 6/12/2025
16.0.0-alpha0005 278 6/10/2025
16.0.0-alpha0002 183 5/11/2025
15.0.14-alpha0003 31 7/16/2025
15.0.13 135 7/3/2025
15.0.13-alpha0003 94 6/22/2025
15.0.12 183 6/16/2025
15.0.12-alpha0007 135 6/16/2025
15.0.12-alpha0001 137 6/3/2025
15.0.11 138 6/1/2025
15.0.11-alpha0017 134 6/1/2025
15.0.11-alpha0009 132 6/1/2025
15.0.11-alpha0003 140 5/27/2025
15.0.10 192 5/11/2025
15.0.10-alpha0011 149 5/8/2025
15.0.9 221 4/22/2025
15.0.9-alpha0003 162 4/21/2025
15.0.8 163 4/18/2025
15.0.8-alpha0008 241 4/13/2025
15.0.8-alpha0003 150 4/6/2025
15.0.7 221 3/30/2025
15.0.7-alpha0019 129 3/30/2025
15.0.7-alpha0010 147 3/23/2025
15.0.7-alpha0008 151 3/23/2025
15.0.7-alpha0003 147 3/18/2025
15.0.6 194 3/12/2025
15.0.6-alpha0003 162 3/10/2025
15.0.5 218 3/7/2025
15.0.5-alpha0003 201 3/4/2025
15.0.4 156 3/3/2025
15.0.4-alpha0003 105 2/24/2025
15.0.3 114 2/19/2025
15.0.3-alpha0005 86 2/16/2025
15.0.3-alpha0003 83 2/16/2025
15.0.2 105 2/13/2025
15.0.2-alpha0004 101 2/10/2025
15.0.1 128 2/7/2025
15.0.1-alpha0005 91 2/6/2025
15.0.0 179 11/19/2024
15.0.0-alpha0012 92 11/17/2024
15.0.0-alpha0010 97 11/12/2024
15.0.0-alpha0006 91 10/23/2024
15.0.0-alpha0004 81 10/17/2024
15.0.0-alpha0003 78 10/17/2024
15.0.0-alpha0001 114 10/9/2024
14.0.6 146 6/1/2025
14.0.6-alpha0015 135 5/27/2025
14.0.6-alpha0006 141 5/8/2025
14.0.5 151 4/22/2025
14.0.5-alpha0005 162 4/22/2025
14.0.4 197 10/8/2024
14.0.4-alpha0003 85 10/31/2024
14.0.3 118 9/27/2024
14.0.3-alpha0013 96 9/26/2024
14.0.2 127 9/23/2024
14.0.2-alpha0005 106 9/22/2024
14.0.1 151 7/4/2024
14.0.1-alpha0010 109 7/1/2024
14.0.1-alpha0003 96 6/24/2024
14.0.0 132 6/6/2024
14.0.0-alpha0008 110 6/6/2024
14.0.0-alpha0005 109 6/6/2024
14.0.0-alpha0003 109 6/4/2024
14.0.0-alpha0001 100 5/25/2024
13.0.6-alpha0009 29 7/16/2025
13.0.5 275 6/12/2025
13.0.5-alpha0013 132 6/3/2025
13.0.5-alpha0006 217 5/12/2025
13.0.4 340 4/23/2025
13.0.4-alpha0002 156 4/21/2025
13.0.3 307 3/30/2025
13.0.3-alpha0003 138 3/18/2025
13.0.2 2,994 10/28/2024
13.0.2-alpha0008 89 10/23/2024
13.0.1 1,548 5/25/2024
13.0.0 147 5/25/2024
13.0.0-alpha0001 104 5/25/2024
12.0.2 137 6/16/2025
12.0.1 116 5/25/2024
12.0.0 120 5/25/2024
12.0.0-alpha0001 110 5/25/2024
10.0.5 276 6/12/2025
10.0.5-alpha0015 131 6/2/2025
10.0.5-alpha0007 206 5/12/2025
10.0.4 154 3/30/2025
10.0.4-alpha0003 152 3/30/2025
10.0.3 98 1/29/2025
10.0.2 109 10/28/2024
10.0.2-alpha0030 90 10/23/2024
10.0.2-alpha0018 115 9/29/2024
10.0.2-alpha0008 89 9/29/2024
10.0.1 128 5/25/2024
10.0.0 123 5/25/2024
10.0.0-alpha0001 118 5/25/2024
0.3.1 940 4/5/2024
0.3.0 166 4/2/2024
0.2.0 163 3/31/2024
0.1.1 613 1/8/2024
0.1.0 145 1/8/2024