SplatDev.Umbraco.Plugins.Faqs
2.0.1
dotnet add package SplatDev.Umbraco.Plugins.Faqs --version 2.0.1
NuGet\Install-Package SplatDev.Umbraco.Plugins.Faqs -Version 2.0.1
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="SplatDev.Umbraco.Plugins.Faqs" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="SplatDev.Umbraco.Plugins.Faqs" Version="2.0.1" />
<PackageReference Include="SplatDev.Umbraco.Plugins.Faqs" />
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 SplatDev.Umbraco.Plugins.Faqs --version 2.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: SplatDev.Umbraco.Plugins.Faqs, 2.0.1"
#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 SplatDev.Umbraco.Plugins.Faqs@2.0.1
#: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=SplatDev.Umbraco.Plugins.Faqs&version=2.0.1
#tool nuget:?package=SplatDev.Umbraco.Plugins.Faqs&version=2.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
UmbracoCms.Plugins.Faqs
FAQ management plugin for Umbraco 13 (net8.0) and Umbraco 17 (net10.0).
Features
- FAQ categories with slug and sort order
- FAQ items with question, answer, category, sort order and publish toggle
- Full-text search across questions and answers
- Accordion-style front-end view component using native HTML
<details>/<summary> - Backoffice dashboard (Umbraco 17: Lit 3 element; Umbraco 13: AngularJS)
- Overview tab with live accordion preview
REST API
| Method | Endpoint | Description |
|---|---|---|
| GET | /umbraco/api/faqs/GetCategories?publishedOnly= |
List categories with items |
| GET | /umbraco/api/faqs/GetCategory?slug=&publishedOnly= |
Get category by slug |
| GET | /umbraco/api/faqs/GetItems?categoryId=&publishedOnly= |
List all FAQ items |
| GET | /umbraco/api/faqs/GetItem?id= |
Get single FAQ item |
| GET | /umbraco/api/faqs/Search?q=&publishedOnly= |
Search FAQs |
| POST | /umbraco/api/faqs/CreateItem |
Create FAQ item |
| PUT | /umbraco/api/faqs/UpdateItem |
Update FAQ item |
| DELETE | /umbraco/api/faqs/DeleteItem?id= |
Delete FAQ item |
| POST | /umbraco/api/faqs/PublishItem?id=&publish= |
Toggle publish state |
| POST | /umbraco/api/faqs/CreateCategory |
Create category |
| DELETE | /umbraco/api/faqs/DeleteCategory?categoryId= |
Delete category |
Front-end View Component
@* All FAQs grouped by category: *@
@await Component.InvokeAsync("Faqs")
@* Specific category only: *@
@await Component.InvokeAsync("Faqs", new { categorySlug = "general" })
@* Search results: *@
@await Component.InvokeAsync("Faqs", new { searchQuery = Request.Query["faqSearch"].ToString() })
Database
Uses EF Core with SQL Server. Schema: faqs. Run migrations:
dotnet ef migrations add InitialFaqs --project UmbracoCms.Plugins.Faqs
dotnet ef database update --project UmbracoCms.Plugins.Faqs
Building the client
cd client
npm install
npm run build
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | 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 is compatible. 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.
-
net10.0
- Microsoft.EntityFrameworkCore.Design (>= 10.0.7)
- Microsoft.EntityFrameworkCore.SqlServer (>= 10.0.7)
- Umbraco.Cms.Core (>= 17.3.4)
- Umbraco.Cms.Web.Common (>= 17.3.4)
-
net8.0
- Microsoft.EntityFrameworkCore.Design (>= 8.0.20)
- Microsoft.EntityFrameworkCore.SqlServer (>= 8.0.20)
- Umbraco.Cms.Core (>= 13.12.0)
- Umbraco.Cms.Web.Common (>= 13.12.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.