Documentation
Kitchen Sink documentation of style: 'Delos' of skin: 'ILIAS'
Action
Description
- Purpose
- Consumers may attach Actions to the table; an Action is a Signal or URL carrying a parameter that references the targeted record(s). While there are Actions that make sense for only one record (e.g. "edit" or "goto"), there are others that will only be used with more than one record (e.g. "export", "compare"), and finally those to be valid for both single and multi records (e.g. "delete"). However, Actions share a common concept - they will trigger an URL or Signal, relay a parameter derived from the record to identify targets and bear a label.
- Composition
- An additional column will be added at the very end of the table containing a Button (or Dropdown, for more than one action) if applicable. If there is at least one Multi Action, an unlabled column will be added at the very beginning of the table containing a checkbox to include the row in the selection. There is also a "withDisabledAction"-switch on an Action to opt out an Action for a specific row; use it to disable a specific Action by introspection of a record or to exit early on multi-Actions with invalid selections.
Rules
- Usage
- Actions MUST have a meaningful label describing the purpose of the action.
- Asynchronous Actions MUST return a MessageBox or an Interruptive Modals.
Relations
- Parents
- UIComponent
- Table
- Descendants
- Standard
- Single
- Multi