Allow `description` in token groups

six7 commented 1 year ago

The DTCG format specifies that you can have a description property on token groups. Let's allow that.

We currently allow users to Rename a token group. Let's rename that to Edit which opens a modal allowing users to edit the name, description and type of a token group (we already support the type property, but we currently only let users add it in JSON. Let's add it in the UI as well).
Add type input
Add description textarea
Add Cancel button
Add Save button

If there's a group description present, display it to the right of the group name.
The group description should take up the remaining space of the row, but not be multi-line
The group name should not be multi-line and should not shrink if the description is longer.
If something would be truncated, it should be the description.

SamIam4Hyma commented 7 months ago

@six7 while reviewing this for V2 planning I have some questions/unknowns:

Where does this information appear in the process / why would I bother to populate it / who cares about this metadata?
- Today, in the plugin, we group by type, but in the future, we can group by intuitive measures, so is this to support that?
How does this appear in the JSON? Is it different if I am switching between the new DTCG and legacy token formats?
What happens when I have several nested groups? (ex: actions.cta-buttons.brand-tier1.icon.size)
When the description is added and truncated, how can I see the full name in the plugin?
When token group type is assigned, does that change the token type?
On token group type, you have copy that says "unless otherwise specified" - what does that mean?
What impact does this have on transformation/using in code if any?

SamIam4Hyma commented 6 months ago

@six7 are we moving from V2 to a later release? can you please adjust the label for me to reflect what you are thinking?

SamIam4Hyma commented 6 months ago

SamIam4Hyma commented 6 months ago

tokens-studio / figma-plugin