docs: add development section on action menus (#2429)

Closes #2428
This commit is contained in:
Henry Wilkinson 2025-03-19 18:46:09 -04:00 committed by GitHub
parent c9c32d86e2
commit cf6690e74a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 21 additions and 1 deletions

View File

@ -0,0 +1,17 @@
# Action Menus
While controls are always placed next to the most relevant content area, we expose most controls for an object in an _Actions_ dropdown menu to enable discovery of actions in a single place, and allow power-users to quickly accomplish tasks.
We try to avoid surfacing navigation options in action menus as they are not tagged as navigation elements. Sometimes we expose links here for convenience, but navigating to another page should never only be possible through an actions menu.
## Implementation
Action menus should generally contain a consistent set of actions for a given object. Whereas new table rows symbolize horizontal separators, these actions should be ordered as follows:
| Dropdown Actions |
| ----------------------------------------------------------------------------------------------------------------------------------------- |
| • Actions related only to the current page (eg: remove archived item from collection) |
| • Actions related to editing the object (eg: edit workflow config, edit item metadata)<br>• Other actions related to the current object (eg: run crawl) |
| • Actions related to exporting/downloading (eg: download archived item) |
| • Copy information to clipboard (eg: copy share link)<br>• Copy IDs to clipboard (eg: copy item ID) |
| • Destructive actions (eg: delete item) |

View File

@ -15,7 +15,7 @@ Docs are organized into the following sections:
- [User Guide](./user-guide/index.md) — Instructions on how to use Browsertrix to create and share web archives.
- [Self-Hosting](./deploy/index.md) — Instructions on how to install, set up, and deploy self-hosted Browsertrix.
- [Development](./develop/index.md) — Contribute to the open source development of Browsertrix software.
- [API Reference](/api) - Full API reference for interacting with the Browsertrix backend.
- [API Reference](/api) Full API reference for interacting with the Browsertrix backend.
If you have feedback on the docs, please feel free to [reach out to us](mailto:docs-feedback@webrecorder.net).

View File

@ -90,10 +90,13 @@ nav:
- develop/index.md
- develop/local-dev-setup.md
- develop/docs.md
- UI Development:
- develop/frontend-dev.md
- develop/ui/components.md
- develop/localization.md
- Design:
- develop/design-action-menus.md
- API Reference: !ENV [ API_DOCS_URL, "/api/" ]