symbol

data

Label used to describe the symbol that will be announced to screen readers.

label

Children elements to be hidden within this component.

children

__@iterator@6562

Returns an object whose properties have the value 'true'
when they will be absent when used in a 'with' statement.

__@unscopables@11079

Returns the item located at the specified index.
@param index The zero-based index of the desired code unit. A negative index will count back from the last item.

Combines two or more arrays.
This method returns a new array without modifying any existing arrays.
@param items Additional arrays and/or items to add to the end of the array.
@param items Additional arrays and/or items to add to the end of the array.

concat

Returns the this object after copying a section of the array identified by start and end
to the same array starting at position target
@param target If target is negative, it is treated as length+target where length is the
length of the array.
@param start If start is negative, it is treated as length+start. If end is negative, it
is treated as length+end.
@param end If not specified, length of the this object is used as its default value.

copyWithin

Returns an iterable of key, value pairs for every entry in the array

entries

Determines whether all the members of an array satisfy the specified test.
@param predicate A function that accepts up to three arguments. The every method calls
the predicate function for each element in the array until the predicate returns a value
which is coercible to the Boolean value false, or until the end of the array.
@param thisArg An object to which the this keyword can refer in the predicate function.
If thisArg is omitted, undefined is used as the this value.
@param predicate A function that accepts up to three arguments. The every method calls
the predicate function for each element in the array until the predicate returns a value
which is coercible to the Boolean value false, or until the end of the array.
@param thisArg An object to which the this keyword can refer in the predicate function.
If thisArg is omitted, undefined is used as the this value.

every

Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
@param value value to fill array section with
@param start index to start filling the array at. If start is negative, it is treated as
length+start where length is the length of the array.
@param end index to stop filling the array at. If end is negative, it is treated as
length+end.

fill

Returns the elements of an array that meet the condition specified in a callback function.
@param predicate A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
@param thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
@param predicate A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
@param thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

filter

Returns the value of the first element in the array where predicate is true, and undefined
otherwise.
@param predicate find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found, find
immediately returns that element value. Otherwise, find returns undefined.
@param thisArg If provided, it will be used as the this value for each invocation of
predicate. If it is not provided, undefined is used instead.

find

Returns the index of the first element in the array where predicate is true, and -1
otherwise.
@param predicate find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found,
findIndex immediately returns that element index. Otherwise, findIndex returns -1.
@param thisArg If provided, it will be used as the this value for each invocation of
predicate. If it is not provided, undefined is used instead.

findIndex

Returns a new array with all sub-array elements concatenated into it recursively up to the
specified depth.
@param depth The maximum recursion depth

flat

Calls a defined callback function on each element of an array. Then, flattens the result into
a new array.
This is identical to a map followed by flat with depth 1.
@param callback A function that accepts up to three arguments. The flatMap method calls the
callback function one time for each element in the array.
@param thisArg An object to which the this keyword can refer in the callback function. If
thisArg is omitted, undefined is used as the this value.

flatMap

Performs the specified action for each element in an array.
@param callbackfn A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
@param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

forEach

Determines whether an array includes a certain element, returning true or false as appropriate.
@param searchElement The element to search for.
@param fromIndex The position in this array at which to begin searching for searchElement.

includes

Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
@param searchElement The value to locate in the array.
@param fromIndex The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

indexOf

Adds all the elements of an array into a string, separated by the specified separator string.
@param separator A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

join

keys

Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
@param searchElement The value to locate in the array.
@param fromIndex The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

lastIndexOf

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

length

Calls a defined callback function on each element of an array, and returns an array that contains the results.
@param callbackfn A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
@param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Removes the last element from an array and returns it.
If the array is empty, undefined is returned and the array is not modified.

Appends new elements to the end of an array, and returns the new length of the array.
@param items New elements to add to the array.

push

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
@param callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
@param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
@param callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
@param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

reduce

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
@param callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
@param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
@param callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
@param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

reduceRight

Reverses the elements in an array in place.
This method mutates the array and returns a reference to the same array.

reverse

Removes the first element from an array and returns it.
If the array is empty, undefined is returned and the array is not modified.

shift

Returns a copy of a section of an array.
For both start and end, a negative index can be used to indicate an offset from the end of the array.
For example, -2 refers to the second to last element of the array.
@param start The beginning index of the specified portion of the array.
If start is undefined, then the slice begins at index 0.
@param end The end index of the specified portion of the array. This is exclusive of the element at the index 'end'.
If end is undefined, then the slice extends to the end of the array.

slice

Determines whether the specified callback function returns true for any element of an array.
@param predicate A function that accepts up to three arguments. The some method calls
the predicate function for each element in the array until the predicate returns a value
which is coercible to the Boolean value true, or until the end of the array.
@param thisArg An object to which the this keyword can refer in the predicate function.
If thisArg is omitted, undefined is used as the this value.

some

Sorts an array in place.
This method mutates the array and returns a reference to the same array.
@param compareFn Function used to determine the order of the elements. It is expected to return
a negative value if the first argument is less than the second argument, zero if they're equal, and a positive
value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.
```ts
[11,2,22,1].sort((a, b) => a - b)
```

sort

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
@param start The zero-based location in the array from which to start removing elements.
@param deleteCount The number of elements to remove.
@returns An array containing the elements that were deleted.
@param start The zero-based location in the array from which to start removing elements.
@param deleteCount The number of elements to remove.
@param items Elements to insert into the array in place of the deleted elements.
@returns An array containing the elements that were deleted.

splice

Inserts new elements at the start of an array, and returns the new length of the array.
@param items Elements to insert at the start of the array.

unshift

Returns an iterable of values in the array

values

Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

toLocaleString

Returns a string representation of an array.

toString

When true, always display the focus ring, even from mouse
interaction—useful for form elements.

always

tone

enabled

Returns an `<a>` HTML anchor element and sets the name attribute to the text value
@deprecated A legacy feature for browser compatibility
@param name

anchor

Returns a new String consisting of the single UTF-16 code unit located at the specified index.
@param index The zero-based index of the desired code unit. A negative index will count back from the last item.

Returns a `<big>` HTML element
@deprecated A legacy feature for browser compatibility

Returns a `<blink>` HTML element
@deprecated A legacy feature for browser compatibility

blink

Returns a `` HTML element
@deprecated A legacy feature for browser compatibility

bold

Returns the character at the specified index.
@param pos The zero-based index of the desired character.

charAt

Returns the Unicode value of the character at the specified location.
@param index The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.

charCodeAt

Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point
value of the UTF-16 encoded code point starting at the string element at position pos in
the String resulting from converting this object to a String.
If there is no element at that position, the result is undefined.
If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos.

codePointAt

Returns a string that contains the concatenation of two or more strings.
@param strings The strings to append to the end of the string.

Returns true if the sequence of elements of searchString converted to a String is the
same as the corresponding elements of this object (converted to a String) starting at
endPosition – length(this). Otherwise returns false.

endsWith

Returns a `<tt>` HTML element
@deprecated A legacy feature for browser compatibility

fixed

Returns a `` HTML element and sets the color attribute value
@deprecated A legacy feature for browser compatibility

fontcolor

Returns a `` HTML element and sets the size attribute value
@deprecated A legacy feature for browser compatibility
@deprecated A legacy feature for browser compatibility

Returns true if searchString appears as a substring of the result of converting this
object to a String, at one or more positions that are
greater than or equal to position; otherwise, returns false.
@param searchString search string
@param position If position is undefined, 0 is assumed, so as to search all of the String.

Returns the position of the first occurrence of a substring.
@param searchString The substring to search for in the string
@param position The index at which to begin searching the String object. If omitted, search starts at the beginning of the string.

Returns an `` HTML element
@deprecated A legacy feature for browser compatibility

italics

Returns the last occurrence of a substring in the string.
@param searchString The substring to search for.
@param position The index at which to begin searching. If omitted, the search begins at the end of the string.

Returns an `<a>` HTML element and sets the href attribute value
@deprecated A legacy feature for browser compatibility

link

Determines whether two strings are equivalent in the current locale.
Determines whether two strings are equivalent in the current or specified locale.
@param that String to compare to target string
@param that String to compare to target string
@param locales A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.
@param options An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.

localeCompare

Matches a string with a regular expression, and returns an array containing the results of that search.
Matches a string or an object that supports being matched against, and returns an array
containing the results of that search, or null if no matches are found.
@param regexp A variable name or string literal containing the regular expression pattern and flags.
@param matcher An object that supports being matched against.

match

Matches a string with a regular expression, and returns an iterable of matches
containing the results of that search.
@param regexp A variable name or string literal containing the regular expression pattern and flags.

matchAll

Returns the String value result of normalizing the string into the normalization form
named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.
@param form Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default
is "NFC"
@param form Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default
is "NFC"

normalize

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.
The padding is applied from the end (right) of the current string.
@param maxLength The length of the resulting string once the current string has been padded.
If this parameter is smaller than the current string's length, the current string will be returned as it is.
@param fillString The string to pad the current string with.
If this string is too long, it will be truncated and the left-most part will be applied.
The default value for this parameter is " " (U+0020).

padEnd

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.
The padding is applied from the start (left) of the current string.
@param maxLength The length of the resulting string once the current string has been padded.
If this parameter is smaller than the current string's length, the current string will be returned as it is.
@param fillString The string to pad the current string with.
If this string is too long, it will be truncated and the left-most part will be applied.
The default value for this parameter is " " (U+0020).

padStart

Returns a String value that is made from count copies appended together. If count is 0,
the empty string is returned.
@param count number of copies to append

repeat

Replaces text in a string, using a regular expression or search string.
Replaces first match with string or all matches with RegExp.
Replaces text in a string, using an object that supports replacement within a string.
@param searchValue A string to search for.
@param replaceValue A string containing the text to replace for every successful match of searchValue in this string.
@param searchValue A string to search for.
@param replacer A function that returns the replacement text.
@param searchValue A string or RegExp search value.
@param replaceValue A string containing the text to replace for match.
@param searchValue A object can search for and replace matches within a string.
@param replacer A function that returns the replacement text.

replace

Replace all instances of a substring in a string, using a regular expression or search string.
@param searchValue A string to search for.
@param replaceValue A string containing the text to replace for every successful match of searchValue in this string.
@param searchValue A string to search for.
@param replacer A function that returns the replacement text.

replaceAll

Finds the first substring match in a regular expression search.
@param regexp The regular expression pattern and applicable flags.
@param searcher An object which supports searching within a string.

search

Returns a section of a string.
@param start The index to the beginning of the specified portion of stringObj.
@param end The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end.
If this value is not specified, the substring continues to the end of stringObj.

Returns a `` HTML element
@deprecated A legacy feature for browser compatibility

small

Split a string into substrings using the specified separator and return them as an array.
@param separator A string that identifies character or characters to use in separating the string. If omitted, a single-element array containing the entire string is returned.
@param limit A value used to limit the number of elements returned in the array.
@param splitter An object that can split a string.
@param limit A value used to limit the number of elements returned in the array.

split

Returns true if the sequence of elements of searchString converted to a String is the
same as the corresponding elements of this object (converted to a String) starting at
position. Otherwise returns false.

startsWith

Returns a `<strike>` HTML element
@deprecated A legacy feature for browser compatibility

strike

Returns a `` HTML element
@deprecated A legacy feature for browser compatibility

Gets a substring beginning at the specified location and having the specified length.
@deprecated A legacy feature for browser compatibility
@param from The starting position of the desired substring. The index of the first character in the string is zero.
@param length The number of characters to include in the returned substring.

substr

Returns the substring at the specified location within a String object.
@param start The zero-based index number indicating the beginning of the substring.
@param end Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end.
If end is omitted, the characters from start through the end of the original string are returned.

substring

Returns a `` HTML element
@deprecated A legacy feature for browser compatibility

Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.

toLocaleLowerCase

Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.

toLocaleUpperCase

Converts all the alphabetic characters in a string to lowercase.

toLowerCase

Converts all the alphabetic characters in a string to uppercase.

toUpperCase

Removes the leading and trailing white space and line terminator characters from a string.

trim

Removes the trailing white space and line terminator characters from a string.

trimEnd

Removes the leading white space and line terminator characters from a string.
@deprecated A legacy feature for browser compatibility. Use `trimStart` instead

trimLeft

Removes the trailing white space and line terminator characters from a string.
@deprecated A legacy feature for browser compatibility. Use `trimEnd` instead

Prop	Type	Description
symbol	string	Emoji symbol.
data?	DataAttributeMap	Sets data attributes on the component.
label?	string	Label used to describe the symbol that will be announced to screen readers.

Prop	Type	Description
children?	ReactNode: string \| number \| false \| true \| {} \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal	Children elements to be hidden within this component.
data?	DataAttributeMap	Sets data attributes on the component.

Accessibility

Installation

Emoji

VisuallyHidden

Props

Emoji Props

VisuallyHidden Props