CSS property page template

Note: Remove this whole explanatory note before publishing


Page front matter:

The frontmatter at the top of the page is used to define "page metadata". The values should be updated appropriately for the particular property.

---
title: NameOfTheProperty
slug: Web/CSS/NameOfTheProperty
tags:
  - CSS
  - Reference
  - CSS Property
  - NameOfTheProperty
  - Experimental
  - Deprecated
browser-compat: css.properties.NameOfTheProperty
---
title

Title heading displayed at top of page. Format as _NameOfTheProperty. For example, the background-color property has a title of background-color.

slug

The end of the URL path after https://developer.mozilla.org/en-US/docs/). This will be formatted like Web/CSS/NameOfTheProperty. For example, the the background-color property slug is Web/CSS/background-color.

tags

Always include the following tags: CSS, Reference, CSS Property, NameOfTheProperty (e.g. background-color).

Include the following tags as appropriate:

  • Category of property: Layout, Graphics, CSS Background, CSS Colors, other tags as appropriate
  • Technology status: Experimental (if the technology is experimental), Deprecated (if it is deprecated).
  • Any other tags that represent terms people might search for related to the technology.
browser-compat

Replace the placeholder value css.properties.NameOfTheProperty with the query string for the property in the Browser compat data repo. The toolchain automatically uses the key to populate the compatibility and specifications sections (replacing the {{Compat}} and {{Specifications}} macros in those sections, respectively).

Note that you may first need to create/update an entry for the property and its specification in our Browser compat data repo. See our guide on how to do this.


Top-of-page macros

A number of macro calls appear at the top of the content section (immediately below the page frontmatter). You should update or delete them according to the advice below:

  • {{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 that use of the technology is discouraged. If it isn't, then you can remove the macro call.
  • {{CSSRef}} — this must be present on every CSS property page. It generates a suitable CSS sidebar, depending on what tags are included on the page. Remember to remove the {{MDNSidebar}} macro when you copy this page.

Formal definition and Formal syntax sections

The content of the Formal definition and Formal syntax sections is generated in place of {{CSSInfo}} and {{CSSSyntax}} macro, respectively. For these to populate you must ensure an appropriate entry has been filled in for the property in our properties.json data file. See properties.md for more information.

Remember to remove this whole explanatory note before publishing

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 */

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 definition

Value not found in DB!

Formal syntax

No syntax available: No value found in the database.

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

No specification found

No specification data found for css.properties.NameOfTheProperty.
Check for problems with this page or contribute a missing spec_url to mdn/browser-compat-data. Also make sure the specification is included in w3c/browser-specs.

Browser compatibility

No compatibility data found for css.properties.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