Radial

A radial menu.

Radials are SVG-based UI elements built with a TaxonWorks agnostic library, you can get the source to use in your own code at svg_radial_menu.

Radial annotators and navigators

See Icons in TaxonWorks for general information on radials.

The sectors that appear in radials are internally referred to as 'slices'
Both radial annotators and object navigators take an object of some model as input as a Rails global id

Add slices to radial annotators for your model by including annotation concerns such as Shared::Citations or Shared::Depictions on your model. These are detected on initialization and will appear in your radials.
Your Vue task can respond to the addition, deletion, or editing of annotations via a radial annotator by listening for the create, delete, and update events emitted by the annotator.

There are several default navigator slices, like Edit and Show for example, see radial.vue; some of these can be excluded if so desired using the exclude prop
To add slices to the navigator or to modify the actions associated with the default slices, see the object_radials.yml file and documentation therein.
- The TaxonWorks convention for using an id query parameter in your task is to name it <model>_id. Links for tasks added to navigators follow this convention. For example in the object_radials.yml file you can see browse_otus_task listed as a task under Otus - that means that a radial navigator on an Otu with id 1 will include a slice with the text 'Browse OTUs' (the name of the task on its task card) and a link of /tasks/otus/browse?otu_id=1.

Warning

TODO