URP Vocabulary

URP (User-Rendered Patterns) vocabulary definitions for SAP CAP applications.

Installation

npm install urp-vocab

Usage

In your CDS files:

using urp from 'urp-vocab';

// Use structured format (recommended)
annotate MyEntity with @urp.display : {
  views: {
    default: 'card',
    card: {
      template: 'card',
      layout: { height: 'auto' },
      sections: {
        header: {
          items: [
            { widget: 'Title', textPath: 'title' }
          ]
        }
      }
    }
  }
};

// Or use JSON string format
annotate MyEntity with @urp.displaySpec : '{"views":{"default":"card",...}}';

// Attributes path for search/filtering
annotate MyEntity with @urp.attributesPath : 'attributes';

Available Annotations

• @urp.display - Structured display specification (recommended)
• @urp.displaySpec - JSON string display specification
• @urp.displayFull - Full boTypes format display specification
• @urp.attributesPath - Path to entity attributes for search/filtering
• @urp.actions - Actions JSON specification
• @urp.requiresExpand - Array of paths that need expansion

Widget Types

The vocabulary includes definitions for various UI widgets:

• Title, Text, Link, Button, Image
• Price, Status, Separator
• Inline (container), BadgeList

License

MIT