mix icon indicating copy to clipboard operation
mix copied to clipboard

Documentation: "simple" vs. "non-simple" Attributes

Open rickbsgu opened this issue 3 years ago • 0 comments

If I'm reading this correctly, Variants, Decorators, Design Tokens, and Directives are 'non-simple' (or 'active' or 'functional' or 'behavioral') attributes.

Whereas the 'simple' attributes add or set basic styling properties (maybe they should be called 'styling' attributes?) to the underlying widget, these go beyond simple styling properties and add behaviors.

Seems like this distinction should be called out in the docs, somewhere, perhaps its own section after Mixing, with a descriptive page and the various types as sub-pages.

Distinguishing Type - Naming Convention

Another consideration is that maybe they should follow some kind of naming convention to indicate their type. Something like:

  • v-Name for Variant
  • 't-Name' for design Token
  • d-Name for Directive
  • c-Name for deCorator

Also brings up the question as to how they are presented to the mixable widget. Clumping them together with all the other attributes in the Mix is somewhat confusing (even though, yes, they are Attributes.)

Enforcing their placement in the named parameter of their type might be less confusing. (Less so if there's a naming convention?)

Todo

  • [ ] Discuss

Outcome

  • [ ] Section explaining the two distinctions.

  • [ ] Simple Attributes Subpage

  • [ ] Directives Subpage

  • [ ] Design Tokens Subpage

  • [ ] Decorators Subpage

  • [ ] Variants Subpage

These would be distinguished somehow in the API docs, as well.

rickbsgu avatar Jan 14 '22 01:01 rickbsgu