Skip to content

Module · Veva.Modules.Documents

Content with a shape.

Define a model once, with the fields your content needs. Then list, filter, translate and publish its documents on any page, or serve them as JSON.

dotnet add package Veva.Web.Essentials

What it does

News, staff, events: your types.

Models you design

Field types from String and Html to Asset, Linked Documents and Value list. Or start from a model template.

Lists in many designs

A Document List shows them as a table, a grid, tabs or your own components, with paging.

Filters

Filter by folder, field, tag, search text or date, with values bound from a form or the address.

Friendly URLs

A Document friendly URL rule gives each document an address such as /news/my-story/.

Feeds and headless

Serve a model as JSON, XML, RSS or iCal, or read it through the headless Documents API.

Import, languages, drafts

Import CSV rows, translate the localizable fields, and publish drafts when they are ready.

How it works

From a model to a page.

  1. 01

    Create a model

    Give it fields, languages and a UID format, or start from a model template.

    IModelTemplate
  2. 02

    Add documents

    Write them in the editor, import a CSV file, or take them from a Document Form.

  3. 03

    List them

    Place a Document List on a page and pick its design and filters.

    Document List
  4. 04

    Show one

    A detail page shows a single document. Bind its fields with {title}.

  5. 05

    Give it an address

    A routing rule turns ?uid= into a friendly URL.

    DocumentFriendlyUrlRule

For developers

Fields, handlers and feeds of your own.

Add a field type, react when documents are added, updated or deleted, or serve a model in a format of your own. Components bind document fields by name.

NewsTitle.razor
@code {
    [CascadingParameter(Name = "RenderContext")]
    public RenderContext RenderContext { get; set; }

    // In a Document List's template, an editor sets it to
    // "{title} · {_Published:d. MMMM yyyy}"
    [EditorBrowsable, Parameter, DisplayName("Title")]
    [EditorArgument("databinding", true)]
    public string Title { get; set; }
}

<h3>@RenderContext.DataBindingContext.FormatString(Title)</h3>

Keep reading

Guides for this module.

All articles

More of Veva

Explore the other modules.

Each one is a package. Reference it, restart, and its components are in the editor.

All modules

Page builder

Compose pages from components, then preview and publish

Open

Assets

One media library, with images sized on request

Open

Search

Crawl, index and search the whole site

Open

Veva core

BuildVeva(), modules, components, themes and hooks

Open

Integrations

Data sources, sign-in, mail, analytics and media

Open

Type to search the docs, components and API.

↑↓ to move ↵ to open Esc to close Search by Veva