CSS selector 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 selector.


title: :NameOfTheSelector
slug: Web/CSS/:NameOfTheSelector
page-type: css-selector OR css-pseudo-class OR css-pseudo-element OR css-combinator
  - experimental
  - deprecated
  - non-standard
browser-compat: css.selectors.NameOfTheSelector

Title heading displayed at top of page. Format as :NameOfTheSelector. For example, the :hover selector has a title of :hover.


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


The page-type key for CSS properties is one of css-selector, css-pseudo-class, or css-pseudo-element, depending on whether the selector is a pseudo-class, a pseudo-element, a combinator, or a basic selector.


Include (appropriate) technology status keys: experimental, deprecated, non-standard (if not on a standards track).


Replace the placeholder value css.selectors.NameOfTheSelector with the query string for the selector 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 selector 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 selector 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.

Syntax section ({{CSSSyntax}})

The content of the Syntax section is generated using the {{CSSSyntax}} macro. For these to populate you must ensure an appropriate entry has been filled in for the selector in our selectors.json data file. See selectors.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 selector and saying what it does. This should ideally be 1 or 2 short sentences.


/* Insert code block showing common use cases */


Error: could not find syntax for this item


Note that we use the plural "Examples" even if the page only contains one example.

A descriptive heading

Each example must have an H3 heading (###) naming the example. The heading should be descriptive of what the example is doing. For example, "A simple example" does not say anything about the example and therefore, not a good heading. The heading should be concise. For a longer description, use the paragraph after the heading.

See our guide on how to add code examples for more information.

Note: Sometimes you will want to link to examples given on another page.

Scenario 1: If you have some examples on this page and some more examples on another page:

Include an H3 heading (###) for each example on this page and then a final H3 heading (###) with the text "More examples", under which you can link to the examples on other pages. For example:


## Examples

### Using the fetch API

Example of Fetch

### More examples

Links to more examples on other pages

Scenario 2: If you only have examples on another page and none on this page:

Don't add any H3 headings; just add the links directly under the H2 heading "Examples". For example:


## Examples

For examples of this API, see [the page on fetch()](https://example.org).

Accessibility concerns

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


No specification found

No specification data found for css.selectors.NameOfTheSelector.
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

BCD tables only load in the browser

See also

Include links to reference pages and guides related to the current selector. For more guidelines, see the See also section in the Writing style guide.

  • link1
  • link2