Which characters are valid in CSS class names/selectors?
Asked Answered
A

11

1342

What characters/symbols are allowed within the CSS class selectors?

I know that the following characters are invalid, but what characters are valid?

~ ! @ $ % ^ & * ( ) + = , . / ' ; : " ? > < [ ] \ { } | ` #
Aloft answered 15/1, 2009 at 23:37 Comment(11)
Related question: stackoverflow.com/questions/2812072/…Bertelli
what about utf8 characters? Like i may type in greekCaressa
Special characters can be used in class names by escaping them - in your CSS file you can define a .hello/world class by escaping the backslash: .hello\2fworld, hello\2f world or hello\/worldSearchlight
Another related question, not about "syntax of names", but about "syntax of class attribute" when expressing multiple names.Donata
@DarrylHein: The incorrect assumption is that CSS class selectors may not contain - or _.Ulterior
You can also use emoji. npmjs.com/package/postcss-modules-emoji-classnameEnsure
One of my favorite characters to use when naming classes is ⦘ . Look at how easy it is to read and understand .BOX⦘BUTTON or .CARD⦘HERO . Use multiple levels of identification .CARD⦘PAGE1⦘HERO and so on. I think that labeling the class names in all caps makes everything way more readable . You're welcome.Lasagne
Other good unicode characters are as follows ⦁⦂⦚⦘🞍┃◼░▯◊🞡🞨Lasagne
@Searchlight I'm guessing that you meant "escaping WITH A backslash"? In all of your examples, the backslash (``) was not escaped, but came before another character that it was apparently escaping.Ait
Check these references :https://www.w3.org/TR/CSS21/selector.html%23id-selectors, https://web.dev/learn/css/selectors/Sham
What about TailWindCSS? It uses : in its classes and it seems to be validLentil
M
1121

You can check directly at the CSS grammar.

Basically1, a name must begin with an underscore (_), a hyphen (-), or a letter(az), followed by any number of hyphens, underscores, letters, or numbers. There is a catch: if the first character is a hyphen, the second character must2 be a letter or underscore, and the name must be at least 2 characters long.

-?[_a-zA-Z]+[_a-zA-Z0-9-]*

In short, the previous rule translates to the following, extracted from the W3C specification:

In CSS, identifiers (including element names, classes, and IDs in selectors) can contain only the characters [a-z0-9] and ISO 10646 characters U+00A0 and higher, plus the hyphen (-) and the underscore (_); they cannot start with a digit, or a hyphen followed by a digit. Identifiers can also contain escaped characters and any ISO 10646 character as a numeric code (see next item). For instance, the identifier "B&W?" may be written as "B&W?" or "B\26 W\3F".

Identifiers beginning with a hyphen or underscore are typically reserved for browser-specific extensions, as in -moz-opacity.

1 It's all made a bit more complicated by the inclusion of escaped Unicode characters (that no one really uses).

2 Note that, according to the grammar I linked, a rule starting with two hyphens, e.g., --indent1, is invalid. However, I'm pretty sure I've seen this in practice.

Microampere answered 15/1, 2009 at 23:42 Comment(4)
NB: The W3C says that the use of a leading '-' or '_' should be reserved for vendor-specific CSS extensions (e.g., -moz* classes implemented by Mozilla browsers).Tetreault
i added sample of not starting with _ - or letter but emoji. I do NOT recommend such naming for classes yet it works. Good to know for general curiosity. https://mcmap.net/q/17913/-which-characters-are-valid-in-css-class-names-selectorsHelenehelenka
As of 2022, the CSS spec defines a class-name (in a .css rule's selector) as "." + ident, and the lexical scanner rules for ident specifially allow any character outside of 0x00-0x7F in a class name after an initial [_A-Za-z] character, so the [_a-zA-Z0-9-]* pattern posted here is incorrect.Unquiet
This incorrectly accepts a{ as in a{ { color: red; }.Ancestor
E
218

To my surprise most answers here are wrong. It turns out that:

Any character except NUL is allowed in CSS class names in CSS. (If CSS contains NUL (escaped or not), the result is undefined. [CSS-characters]) In HTML though, permanently unassigned codepoints are not permitted either. Neither does HTML have a way to include space characters (space, tab, line feed, form feed and carriage return) in a class name attribute, because those are class lists and spaces are used here to separate class names from each other.

Mathias Bynens' answer links to explanation and demos showing how to use these names. Written down in CSS code, a class name may need escaping, but that doesn’t change the class name. E.g. an unnecessarily over-escaped representation will look different from other representations of that name, but it still refers to the same class name.

Most other (programming) languages don’t have that concept of escaping variable names (“identifiers”), so all representations of a variable have to look the same. This is not the case in CSS.

So, if you need to turn a random string into a CSS class name: take care of NUL and space, and escape (accordingly for CSS or HTML). Done.

Euphrasy answered 18/7, 2011 at 12:32 Comment(0)
T
88

I’ve answered your question in-depth at CSS character escape sequences. The article also explains how to escape any character in CSS (and JavaScript), and I made a handy tool for this as well. From that page:

If you were to give an element an ID value of ~!@$%^&*()_+-=,./';:"?><[]{}|`#, the selector would look like this:

CSS:

<style>
  #\~\!\@\$\%\^\&\*\(\)\_\+-\=\,\.\/\'\;\:\"\?\>\<\[\]\\\{\}\|\`\#
  {
    background: hotpink;
  }
</style>

JavaScript:

<script>
  // document.getElementById or similar
  document.getElementById('~!@$%^&*()_+-=,./\';:"?><[]\\{}|`#');
  // document.querySelector or similar
  $('#\\~\\!\\@\\$\\%\\^\\&\\*\\(\\)\\_\\+-\\=\\,\\.\\/\\\'\\;\\:\\"\\?\\>\\<\\[\\]\\\\\\{\\}\\|\\`\\#');
</script>
Tricolor answered 6/7, 2011 at 6:41 Comment(0)
L
72

Read the W3C spec. (this is CSS 2.1; find the appropriate version for your assumption of browsers)

relevant paragraph:

In CSS, identifiers (including element names, classes, and IDs in selectors) can contain only the characters [a-z0-9] and ISO 10646 characters U+00A1 and higher, plus the hyphen (-) and the underscore (_); they cannot start with a digit, or a hyphen followed by a digit. Identifiers can also contain escaped characters and any ISO 10646 character as a numeric code (see next item). For instance, the identifier "B&W?" may be written as "B&W?" or "B\26 W\3F".

As @mipadi points out in Kenan Banks's answer, there's this caveat, also in the same webpage:

In CSS, identifiers may begin with '-' (dash) or '_' (underscore). Keywords and property names beginning with '-' or '_' are reserved for vendor-specific extensions. Such vendor-specific extensions should have one of the following formats:

'-' + vendor identifier + '-' + meaningful name
'_' + vendor identifier + '-' + meaningful name

Example(s):

For example, if XYZ organization added a property to describe the color of the border on the East side of the display, they might call it -xyz-border-east-color.

Other known examples:

-moz-box-sizing
-moz-border-radius
-wap-accesskey

An initial dash or underscore is guaranteed never to be used in a property or keyword by any current or future level of CSS. Thus typical CSS implementations may not recognize such properties and may ignore them according to the rules for handling parsing errors. However, because the initial dash or underscore is part of the grammar, CSS 2.1 implementers should always be able to use a CSS-conforming parser, whether or not they support any vendor-specific extensions.

Authors should avoid vendor-specific extensions

Lechner answered 15/1, 2009 at 23:45 Comment(0)
M
28

The complete regular expression is:

-?(?:[_a-z]|[\200-\377]|\\[0-9a-f]{1,6}(\r\n|[ \t\r\n\f])?|\\[^\r\n\f0-9a-f])(?:[_a-z0-9-]|[\200-\377]|\\[0-9a-f]{1,6}(\r\n|[ \t\r\n\f])?|\\[^\r\n\f0-9a-f])*

So all of your listed characters, except “-” and “_” are not allowed if used directly. But you can encode them using a backslash foo\~bar or using the Unicode notation foo\7E bar.

Mclemore answered 16/1, 2009 at 0:5 Comment(1)
This incorrectly accepts a{ as in a{ { color: red; }.Ancestor
P
18

For those looking for a workaround, you can use an attribute selector, for instance, if your class begins with a number. Change:

.000000-8{background:url(../../images/common/000000-0.8.png);} /* DOESN'T WORK!! */

to this:

[class="000000-8"]{background:url(../../images/common/000000-0.8.png);} /* WORKS :) */

Also, if there are multiple classes, you will need to specify them in selector or use the ~= operator:

[class~="000000-8"]{background:url(../../images/common/000000-0.8.png);}

Sources:

  1. https://benfrain.com/when-and-where-you-can-use-numbers-in-id-and-class-names/
  2. Is there a workaround to make CSS classes with names that start with numbers valid?
  3. https://developer.mozilla.org/en-US/docs/Web/CSS/Attribute_selectors
Persevere answered 23/6, 2016 at 17:33 Comment(0)
H
9

I would not recommend to use anything except A-z, _- and 0-9, while it's just easier to code with those symbols. Also do not start classes with - while those classes are usually browser-specific flags. To avoid any issues with IDE autocompletion, less complexity when you may need to generate those class names with some other code for whatever reason. Maybe some transpiling software may not work, etc., etc.

Yet CSS is quite loose on this. You can use any symbol, and even emoji works.

<style>
  .😭 {
    border: 2px solid blue;
    width: 100px;
    height: 100px;
    overflow: hidden;
  }
</style>

<div class="😭">
  😅😅😅😅😅😅😅😅😅😅😅😅😅😅😅😅😅😅😅😅
</div>

Enter image description here

Helenehelenka answered 14/11, 2021 at 13:37 Comment(0)
T
6

My understanding is that the underscore is technically valid. Check out:

https://developer.mozilla.org/en/underscores_in_class_and_id_names

"...errata to the specification published in early 2001 made underscores legal for the first time."

The article linked above says never use them, then gives a list of browsers that don't support them, all of which are, in terms of numbers of users at least, long-redundant.

Twentyfourmo answered 31/7, 2010 at 5:33 Comment(1)
The link is broken: "Page not found"Chinachinaberry
P
6

We can use all characters in a class name. Even characters like # and .. We just have to escape them with \ (backslash).

.test\.123 {
  color: red;
}

.test\#123 {
  color: blue;
}

.test\@123 {
  color: green;
}

.test\<123 {
  color: brown;
}

.test\`123 {
  color: purple;
}

.test\~123 {
  color: tomato;
}
<div class="test.123">test.123</div>
<div class="test#123">test#123</div>
<div class="test@123">test@123</div>
<div class="test<123">test<123</div>
<div class="test`123">test`123</div>
<div class="test~123">test~123</div>
Piscatelli answered 5/8, 2020 at 15:50 Comment(0)
I
5

For HTML5 and CSS 3, classes and IDs can start with numbers.

Ichthyosaur answered 12/10, 2009 at 14:4 Comment(1)
But css selectors still need to be escaped by unicode code point. Ex: css selector for class 10 needs to be .\31 0Demulcent
P
0

Going off of Kenan Banks's answer, you can use the following two regex matches to make a string valid:

[^a-z0-9A-Z_-]

This is a reverse match that selects anything that isn't a letter, number, dash or underscore for easy removal.

^-*[0-9]+

This matches 0 or 1 dashes followed by 1 or more numbers at the beginning of a string, also for easy removal.

How I use it in PHP:

// Make alphanumeric with dashes and underscores (removes all other characters)
$class = preg_replace("/[^a-z0-9A-Z_-]/", "", $class);

// Classes only begin with an underscore or letter
$class = preg_replace("/^-*[0-9]+/", "", $class);

// Make sure the string is two or more characters long
return 2 <= strlen($class) ? $class : '';
Pachydermatous answered 7/9, 2019 at 14:42 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.