Usability Tip: Use Categories to Prefix Component Names

The component name should reflect its usage within its name. A best practice is to prepend its intended usage with the major category of its function. Because the component sidekick sorts component names alphabetically, you can group by prefixing all component names with their major category. For example:

  • Content – Promotion Pod
  • Content – Image Carousel
  • Layout – Column Control
  • Layout – Three-tabbed Panel
  • Navigation – List of Links
  • Navigation – Call to Action
  • Social – Share Button
  • Social – Twitter

When this list of components is sorted within the component Sidekick, the content author can see the major function of the component and quickly make a decision on which to use without scrolling through an exhaustive, unorganized list. Using this approach in conjunction with the grouping feature of the Sidekick gives the content author a well-organized toolbox to quickly assemble pages.


Sidekick Organization

6 thoughts on “Usability Tip: Use Categories to Prefix Component Names

  1. Another way could be having a drop down at component level for all such views. For example in your list, Navigation being just one component but having a dropdown to choose one of List of Links & Call to Action view. This makes developer life quite easy and promotes more re-usability and at the same time help Author not to get confused like you mentioned.

  2. Pingback: Using Categories as Name Prefix for Components | Terra Beata

Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s