Skip to main content

Renderers Editors For Attributes

  • Editor: the UI component that allows the user to input or change the value of an attribute (for example, a text box, dropdown, date picker, or checkbox).

  • Renderer: the UI component that displays the attributes value in a read-only or formatted way (for example, showing a formatted date, a colored label, or a masked password).

Standard Renderers and Editors by Attribute Type

1. Text Attribute

Editor Options for Text Attribute

NameDisplay NameDescription
DefaultDefaultStandard text input editor.
MaskedValueMasked ValueInput field with masking (e.g., for phone numbers, SSN, etc.).
ColorPickerColor PickerAllows users to pick a color, stores the value as text (e.g., hex code).

Renderer Options for Text Attribute

NameDisplay NameDescription
DefaultDefaultStandard text display.
MaskedValueMasked ValueDisplays the text in a masked format (e.g., hides part of the value).
ColorPickerColor PickerRenders the text as a color swatch or visual color representation.
UrlURLRenders the text as a clickable hyperlink.
EmailEmailRenders the text as a clickable email link (mailto:).

2. Date Attribute

Editor Options for Date Attribute

NameDisplay NameDescription
DefaultDefaultStandard date picker input (uses <ProtrakDate /> component for date selection).
MonthYearMonth YearSpecialized editor for selecting only month and year (uses <MonthYearAttributeEditor />).

Renderer Options for Date Attribute

NameDisplay NameDescription
DefaultDefaultStandard date display (uses <FormattedDate /> to show the date in the configured format).
MonthYearMonth YearSpecialized renderer for displaying only month and year (uses <MonthYearAttributeRenderer />).

3. DateTime Attribute

Editor Options for DateTime Attribute

NameDisplay NameDescription
DefaultDefaultStandard date-time picker input (uses <ProtrakDateTime /> for selecting both date and time).
TimeTimeSpecialized editor for selecting only the time part (uses <TimeAttributeEditor />).

Renderer Options for DateTime Attribute

NameDisplay NameDescription
DefaultDefaultStandard date-time display (uses <FormattedDateTime /> to show date and time in configured format).
TimeTimeSpecialized renderer for displaying only the time part (uses <TimeAttributeRenderer />).

4. Numeric Attribute

Editor Options for Numeric Attribute

NameDisplay NameDescription
DefaultDefaultStandard numeric input editor (typically a number field for entering values).

Renderer Options for Numeric Attribute

NameDisplay NameDescription
DefaultDefaultStandard numeric display (shows the number in the default format).
UnformattedUnformattedDisplays the numeric value without any formatting (e.g., no commas, currency, or decimals).
PhoneNumberPhone Number (NANP)Renders the numeric value as a North American phone number format (e.g., (123) 456-7890).

5. Picklist Attribute

Editor Options for Picklist Attribute

NameDisplay NameDescription
RadioButtonRadio ButtonDisplays picklist options as radio buttons for single selection.
DropdownDrop DownDisplays picklist options in a dropdown/select menu for single selection.
CheckboxCheckboxDisplays picklist options as checkboxes for multi-selection.

Renderer Options for Picklist Attribute

NameDisplay NameDescription
RadioButtonRadio ButtonRenders the selected value as radio button style.
DropdownDrop DownRenders the selected value as dropdown style.
CheckboxCheckboxRenders the selected value as checkbox style.

6. Boolean Attribute

Editor Options for Boolean Attribute

NameDisplay NameDescription
DefaultDefaultStandard boolean input, typically rendered as a checkbox

Renderer Options for Boolean Attribute

NameDisplay NameDescription
DefaultDefaultStandard boolean display (e.g., shows checked/unchecked, Yes/No, True/False).
ReadonlyCheckboxReadonly CheckboxRenders the value as a disabled (readonly) checkbox for display only.

7. Reference Attribute

Editor Options for Reference Attribute

NameDisplay NameDescription
DefaultDefaultDisplays reference options in a searchable paginated popup with data grid for selection.
DropdownDrop DownDisplays reference options in a searchable paginated dropdown for selection.

Default Editor:

Reference Default Editor Reference Default Editor Popup

  • Interactive Selection: Click on the search icon to open a popup with advanced selection capabilities
  • Data Grid View: Displays references in a table format with columns for Name, State, and configured attributes
  • Customizable Columns: Display specific attribute columns based on configuration
  • Multi-select Support: Select multiple references when configured to allow multiple selections
  • Filtering Capabilities: Filter references by attributes and states using a powerful filtering interface
  • Dynamic Loading: Pagination support for efficiently handling large datasets
  • Create Instance: Button to create new related instances directly from the selection popup (when enabled)
  • Advanced Queries: Support for predefined attribute filters, state filters, and dynamic parent filters

Dropdown Editor:

Reference Dropdown Editor

  • Dynamic Search: Real-time filtering of reference options as you type
  • Paginated Scrolling: Progressive loading of results to optimize performance
  • Multiple Selection: Support for selecting multiple references when configured
  • Instance Management: Create new instances or link existing ones directly from the interface
  • Optimized Data Loading: Asynchronous retrieval of reference data for efficiency

Renderer Options for Reference Attribute

NameDisplay NameDescription
DefaultDefaultStandard display showing reference names as clickable links.
ExpandableListExpandable ListCompact display with "Show more/Show less" toggle for multiple references.

Default Renderer:

  • Displays referenced instance names as clickable links
  • Opens referenced instances in new tabs
  • Comma-separated list for multiple references

Expandable List Renderer:

  • Compact view limiting display height
  • Expandable view for complete list - "Show more" link appears when content overflows
  • Responsive design that adapts to container width
  • Maintains clickable links to referenced instances
  • Ideal for attributes with many references
Collapsed ViewExpanded View
Reference Expandable List Renderer - CollapsedReference Expandable List Renderer - Expanded

UI

Editor

Renderer

Renderer