Class naming conventions
Justin
justin.obara at utoronto.ca
Thu Mar 12 12:35:05 UTC 2009
Thank you for this detailed summary Anastasia.
I'm wondering if we should have a convention for the order the classes
appear.
I.e. the DOM-selection class before the visual styling classes.
Not sure how important this is or not, but it might make it easier to
read if they are in a consistent position.
Thanks
Justin
On 11-Mar-09, at 4:54 PM, Anastasia Cheetham wrote:
>
> Today after Jacob's FSS walkthrough, we had a discussion about
> naming conventions for classes for the FSS and for component DOM
> selection. We came up with a general naming scheme, which is
> described below so that anyone who wasn't in on the discussion can
> weigh in.
>
> We decided that we would distinguish between class names used for
> visual styling, and class names used for finding DOM element for
> manipulation, etc. These different categories of classes will have
> different prefixes:
>
> Visual styling class-name prefix: fl-
> DOM-selection prefix: flc-
>
> Visual styling classnames:
>
> The general pattern for visual styling class names is
> fl-[thing]-[role]
>
> So, for example:
> fl-container-flex, fl-layout-linear...
>
> If the visual styling is specifically for a component, then the
> component name is inserted:
> fl-[componentname]-[thing]-[role]
>
> So, for example:
> fl-reorderer-selected, fl-pager-links...
>
>
> DOM-selection classnames:
>
> The general pattern for DOM-selection classnames (i.e. default
> classnames used by a component to find its parts) is
> flc-[componentname]-[thing]-[role]
>
> So, for example:
> flc-reorderer-drop-warning, flc-inlineEdit-displayText...
>
>
>
> Comments, anyone?
>
> --
> Anastasia Cheetham a.cheetham at utoronto.ca
> Software Designer, Fluid Project http://fluidproject.org
> Adaptive Technology Resource Centre / University of Toronto
>
> _______________________________________________________
> fluid-work mailing list - fluid-work at fluidproject.org
> To unsubscribe, change settings or access archives,
> see http://fluidproject.org/mailman/listinfo/fluid-work
More information about the fluid-work
mailing list