CSS property page template

Remove before publishing

Title and slug

A CSS property page should have a title and slug of NameOfTheProperty. For example, the background-color property has a title and slug of background-color.

Top macros

There are four macro calls at the top of the template by default. You should update or delete them according to the advice below:

  • {{draft()}} — this generates a Draft banner that indicates that the page is not yet complete, and should only be removed when the first draft of the page is completely finished. After it is ready to be published, you can remove this.
  • {{SeeCompatTable}} — this generates a This is an experimental technology banner that indicates the technology is experimental). If the technology you are documenting is not experimental, you can remove this. If it is experimental, and the technology is hidden behind a pref in Firefox, you should also fill in an entry for it in the Experimental features in Firefox page.
  • {{deprecated_header}} — this generates a Deprecated banner that indicates the technology is deprecated. If it isn't, then you can remove the macro call.
  • {{CSSRef}} — this generates a suitable CSS sidebar, depending on what tags are included on the page.

Tags

In an CSS property subpage, you need to include the following tags (see the Tags section at the bottom of the editor UI): CSS, Reference, CSS Property, the name of the Property (e.g. background-color), Layout, Graphics, CSS Background/CSS Colors/other category as appropriate, Experimental (if the technology is experimental), and Deprecated (if it is deprecated).

Browser compatibility

To fill in the browser compat data, you first need to fill in an entry for the API into our Browser compat data repo — see our guide on how to do this. Note that for CSS properties, most of the work has already been done — you just need to check that an entry is available.

Once that is done, you can show the compat data for the method with a {{Compat()}} macro call.

{{cssinfo}} and {{csssyntax}} sections

To generate these sections, you need to make sure appropriate entry has been filled in for the property in our properties.json data file. See properties.md for more information.

Draft

This page is not complete.

Experimental

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Deprecated

This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The summary paragraph — start by naming the property and saying what it does. This should ideally be 1 or 2 short sentences.

/* Insert code block showing common use cases */
/* or categories of values */

Value not found in DB!

Syntax

Include a description of the property and what component subvalues make up a complete value.

Values

subvalue1
Include a description of the subvalue, what its datatype is, and what it represents. Include one term and definition for each subvalue.
subvalue2
etc.

Formal syntax

{{csssyntax}}

Examples

Fill in a simple example that nicely shows a typical usage of the property, then perhaps some more complex examples (see our guide on how to add code examples for more information).

my code block

And/or include a list of links to useful code samples that live elsewhere:

  • x
  • y
  • z

Accessibility concerns

Optionally, warn of any potential accessibility concerns that exist with using this property, and how to work around them. Remove this section if there are none to list.

Specifications

Specification Comment Feedback
Unknown
The definition of 'NameOfTheProperty' in that specification.		 Useful comment if there is one. Otherwise remove column Link to useful place to give feedback on the particular spec, e.g. Github issues. If there isn't one, remove column.

Browser compatibility

No compatibility data found for path.to.feature.NameOfTheProperty.
Check for problems with this page or contribute missing data to mdn/browser-compat-data.

See also

  • Include list of
  • other links related to
  • this Element that might
  • be useful