@snack-uikit/list

List

Installation

npm i @snack-uikit/list

Changelog

kindFlattenItems

Props

name	type	default value	description
items*	Item[]	-
prefix	ItemId	-
parentId	ItemId	-

isAccordionItem

Props

name	type	default value	description

isBaseItem

Props

name	type	default value	description

isGroupItem

Props

name	type	default value	description

isNextListItem

Props

name	type	default value	description

isGroupSelectItem

Props

name	type	default value	description

useGroupItemSelection

Props

name	type	default value	description
id*	ItemId	-
items*	ItemId[]	-
allChildIds*	ItemId[]	-
disabled	boolean	-

isSelectionSingleProps

Props

name	type	default value	description

isSelectionMultipleProps

Props

name	type	default value	description

Droplist

Props

name	type	default value	description
items*	Item[]	-	Основные элементы списка
children*	ReactNode | ({onKeyDown}) => ReactNode * Рендер функция принимает аргументы onKeyDown - хендлер ввода, для поддержки управления с клавиатуры	-	Триггер для дроплиста
triggerElemRef	RefObject<HTMLElement>	-	Ссылка на элемент-триггер для дроплиста
listRef	RefObject<HTMLElement>	-	Ссылка на элемент выпадающего списка
closeDroplistOnItemClick	boolean	-	Закрывать выпадающий список после клика на базовый айтем. Работает в режимах selection: 'none' | 'single'
triggerClassName	string	-	CSS-класс триггера
open	boolean	-	Управляет состоянием показан/не показан.
onOpenChange	(isOpen: boolean) => void	-	Колбек отображения компонента. Срабатывает при изменении состояния open.
widthStrategy	enum PopoverWidthStrategy: "auto", "gte", "eq"	auto	Стратегия управления шириной контейнера поповера - auto - соответствует ширине контента, - gte - Great Than or Equal, равен ширине таргета или больше ее, если контент в поповере шире, - eq - Equal, строго равен ширине таргета.
trigger	enum Trigger: "click", "hover", "focusVisible", "focus", "hoverAndFocusVisible", "hoverAndFocus", "clickAndFocusVisible"	-	Условие отображения поповера: - click - открывать по клику - hover - открывать по ховеру - focusVisible - открывать по focus-visible - focus - открывать по фокусу - hoverAndFocusVisible - открывать по ховеру и focus-visible - hoverAndFocus - открывать по ховеру и фокусу - clickAndFocusVisible - открывать по клику и focus-visible
placement	enum Placement: "left", "left-start", "left-end", "right", "right-start", "right-end", "top", "top-start", "top-end", "bottom", "bottom-start", "bottom-end"	top	Положение поповера относительно своего триггера (children).
className	string	-	CSS-класс
pinTop	Item[]	-	Элементы списка, закрепленные сверху
pinBottom	Item[]	-	Элементы списка, закрепленные снизу
footer	ReactNode ;	-	Кастомизируемый элемент в конце списка
footerActiveElementsRefs	RefObject<HTMLElement>[]	-	Список ссылок на кастомные элементы, помещенные в специальную секцию внизу списка
search	SearchState	-	Настройки поисковой строки
collapse	CollapseState	{}	Настройки раскрытия элементов
loading	boolean	-	Флаг, отвещающий за состояние загрузки списка
selection	SelectionSingleState | SelectionMultipleState	-
size	"s" | "m" | "l"	s	Размер списка
marker	boolean	true	Отображать ли маркер у выбранного жлемента списка
contentRender	(props: ContentRenderProps) => ReactNode	-	Рендер функция основного контента айтема
scroll	boolean	-	Включить ли скролл для основной части списка
scrollRef	RefObject<HTMLElement>	-	Ссылка на элемент, обозначающий самый конец прокручиваемого списка
scrollContainerRef	RefObject<HTMLElement>	-	Ссылка на контейнер, который скроллится
untouchableScrollbars	boolean	-	Отключает возможность взаимодействовать со скролбарами мышью.
onScroll	(event?: Event) => void	-	Колбек на скролл прокручиваемого списка
dataFiltered	boolean	-
dataError	boolean	-
noDataState	EmptyStateProps	-	Экран при отстутствии данных
noResultsState	EmptyStateProps	-	Экран при отстутствии результатов поиска или фильтров
errorDataState	EmptyStateProps	-	Экран при ошибке запроса

List

Props

name	type	default value	description
items*	Item[]	-	Основные элементы списка
pinTop	Item[]	-	Элементы списка, закрепленные сверху
pinBottom	Item[]	-	Элементы списка, закрепленные снизу
footer	ReactNode ;	-	Кастомизируемый элемент в конце списка
footerActiveElementsRefs	RefObject<HTMLElement>[]	-	Список ссылок на кастомные элементы, помещенные в специальную секцию внизу списка
keyboardNavigationRef	RefObject<{ focusItem(id: ItemId): void; }>	-	Ссылка на управление навигацией листа с клавиатуры
search	SearchState	-	Настройки поисковой строки
tabIndex	number	-	Tab Index
collapse	CollapseState	{}	Настройки раскрытия элементов
className	string	-	CSS-класс
onKeyDown	(e: KeyboardEvent<HTMLElement>) => void	-
loading	boolean	-	Флаг, отвещающий за состояние загрузки списка
selection	SelectionSingleState | SelectionMultipleState	-
size	"s" | "m" | "l"	s	Размер списка
marker	boolean	true	Отображать ли маркер у выбранного жлемента списка
contentRender	(props: ContentRenderProps) => ReactNode	-	Рендер функция основного контента айтема
scroll	boolean	-	Включить ли скролл для основной части списка
scrollRef	RefObject<HTMLElement>	-	Ссылка на элемент, обозначающий самый конец прокручиваемого списка
scrollContainerRef	RefObject<HTMLElement>	-	Ссылка на контейнер, который скроллится
untouchableScrollbars	boolean	-	Отключает возможность взаимодействовать со скролбарами мышью.
onScroll	(event?: Event) => void	-	Колбек на скролл прокручиваемого списка
dataFiltered	boolean	-
dataError	boolean	-
noDataState	EmptyStateProps	-	Экран при отстутствии данных
noResultsState	EmptyStateProps	-	Экран при отстутствии результатов поиска или фильтров
errorDataState	EmptyStateProps	-	Экран при ошибке запроса
ref	Ref<HTMLElement>	-	Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref). @see https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom
key	Key	-

ItemContent

Props

name	type	default value	description
option*	string | number	-
caption	string	-
description	string	-
truncate	TruncateProps	-
disabled	boolean	-
className	string	-	CSS-класс

getFooterItemId

Props

name	type	default value	description
toPrecision*	(precision?: number) => string	-	Returns a string containing a number represented either in exponential or fixed-point notation with a specified number of digits. @param precision Number of significant digits. Must be in the range 1 - 21, inclusive.
toExponential*	(fractionDigits?: number) => string	-	Returns a string containing a number represented in exponential notation. @param fractionDigits Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.
toFixed*	(fractionDigits?: number) => string	-	Returns a string representing a number in fixed-point notation. @param fractionDigits Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.
__@iterator@1249*	() => IterableIterator<string>	-	Iterator
toWellFormed*	() => string	-	Returns a string where all lone or out-of-order surrogates have been replaced by the Unicode replacement character (U+FFFD).
isWellFormed*	() => boolean	-	Returns true if all leading surrogates and trailing surrogates appear paired and in order.
at*	(index: number) => string	-	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.
replaceAll*	{ (searchValue: string | RegExp, replaceValue: string): string; (searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string): string; }	-	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.
matchAll*	(regexp: RegExp) => IterableIterator<RegExpExecArray>	-	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.
trimRight*	() => string	-	Removes the trailing white space and line terminator characters from a string. @deprecated A legacy feature for browser compatibility. Use trimEnd instead
trimLeft*	() => string	-	Removes the leading white space and line terminator characters from a string. @deprecated A legacy feature for browser compatibility. Use trimStart instead
trimStart*	() => string	-	Removes the leading white space and line terminator characters from a string.
trimEnd*	() => string	-	Removes the trailing white space and line terminator characters from a string.
padEnd*	(maxLength: number, fillString?: string) => string	-	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).
padStart*	(maxLength: number, fillString?: string) => string	-	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).
sup*	() => string	-	Returns a <sup> HTML element @deprecated A legacy feature for browser compatibility
sub*	() => string	-	Returns a <sub> HTML element @deprecated A legacy feature for browser compatibility
strike*	() => string	-	Returns a <strike> HTML element @deprecated A legacy feature for browser compatibility
small*	() => string	-	Returns a <small> HTML element @deprecated A legacy feature for browser compatibility
link*	(url: string) => string	-	Returns an <a> HTML element and sets the href attribute value @deprecated A legacy feature for browser compatibility
italics*	() => string	-	Returns an <i> HTML element @deprecated A legacy feature for browser compatibility
fontsize*	{ (size: number): string; (size: string): string; }	-	Returns a <font> HTML element and sets the size attribute value @deprecated A legacy feature for browser compatibility @deprecated A legacy feature for browser compatibility
fontcolor*	(color: string) => string	-	Returns a <font> HTML element and sets the color attribute value @deprecated A legacy feature for browser compatibility
fixed*	() => string	-	Returns a <tt> HTML element @deprecated A legacy feature for browser compatibility
bold*	() => string	-	Returns a <b> HTML element @deprecated A legacy feature for browser compatibility
blink*	() => string	-	Returns a <blink> HTML element @deprecated A legacy feature for browser compatibility
big*	() => string	-	Returns a <big> HTML element @deprecated A legacy feature for browser compatibility
anchor*	(name: string) => string	-	Returns an <a> HTML anchor element and sets the name attribute to the text value @deprecated A legacy feature for browser compatibility @param name
startsWith*	(searchString: string, position?: number) => boolean	-	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.
repeat*	(count: number) => string	-	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
normalize*	{ (form: "NFC" | "NFD" | "NFKC" | "NFKD"): string; (form?: string): string; }	-	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"
endsWith*	(searchString: string, endPosition?: number) => boolean	-	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.
includes*	(searchString: string, position?: number) => boolean	-	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.
codePointAt*	(pos: number) => number	-	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.
substr*	(from: number, length?: number) => string	-	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.
length*	number	-	Returns the length of a String object.
trim*	() => string	-	Removes the leading and trailing white space and line terminator characters from a string.
toLocaleUpperCase*	{ (locales?: string | string[]): string; (locales?: LocalesArgument): string; }	-	Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.
toUpperCase*	() => string	-	Converts all the alphabetic characters in a string to uppercase.
toLocaleLowerCase*	{ (locales?: string | string[]): string; (locales?: LocalesArgument): string; }	-	Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.
toLowerCase*	() => string	-	Converts all the alphabetic characters in a string to lowercase.
substring*	(start: number, end?: number) => string	-	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.
split*	{ (separator: string | RegExp, limit?: number): string[]; (splitter: { [Symbol.split](string: string, limit?: number): string[]; }, limit?: number): string[]; }	-	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.
slice*	(start?: number, end?: number) => string	-	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.
search*	{ (regexp: string | RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }	-	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.
replace*	{ (searchValue: string | RegExp, replaceValue: string): string; (searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }	-	Replaces text in a string, using a regular expression or search string. Passes a string and {@linkcode replaceValue} to the [Symbol.replace] method on {@linkcode searchValue}. This method is expected to implement its own replacement algorithm. Replaces text in a string, using an object that supports replacement within a string. @param searchValue A string or regular expression to search for. @param replaceValue A string containing the text to replace. When the {@linkcode searchValue } is a RegExp, all matches are replaced if the g flag is set (or only those matches at the beginning, if the y flag is also present). Otherwise, only the first match of {@linkcode searchValue } is replaced. @param searchValue A string to search for. @param replacer A function that returns the replacement text. @param searchValue An object that supports searching for and replacing matches within a string. @param replaceValue The replacement text. @param searchValue A object can search for and replace matches within a string. @param replacer A function that returns the replacement text.
match*	{ (regexp: string | RegExp): RegExpMatchArray; (matcher: { [Symbol.match](string: string): RegExpMatchArray; }): RegExpMatchArray; }	-	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.
localeCompare*	{ (that: string): number; (that: string, locales?: string | string[], options?: CollatorOptions): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions): number; }	-	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. @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.
lastIndexOf*	(searchString: string, position?: number) => number	-	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.
indexOf*	(searchString: string, position?: number) => number	-	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.
concat*	(...strings: string[]) => string	-	Returns a string that contains the concatenation of two or more strings. @param strings The strings to append to the end of the string.
charCodeAt*	(index: number) => number	-	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.
charAt*	(pos: number) => string	-	Returns the character at the specified index. @param pos The zero-based index of the desired character.
toString	(() => string) | ((radix?: number) => string)	function toString() { [native code] }	Returns a string representation of a string. Returns a string representation of an object. @param radix Specifies a radix for converting numeric values to strings. This value is only used for numbers.
valueOf	(() => string) | (() => number)	function valueOf() { [native code] }	Returns the primitive value of the specified object.
toLocaleString	(() => string) | { (locales?: string | string[], options?: NumberFormatOptions): string; (locales?: LocalesArgument, options?: NumberFormatOptions): string; }	function toLocaleString() { [native code] }	Returns a date converted to a string using the current locale. Converts a number to a string by using the current or specified locale. @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. @param options An object that contains one or more properties that specify comparison options. @param locales A locale string, array of locale strings, Intl.Locale object, or array of Intl.Locale objects 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. @param options An object that contains one or more properties that specify comparison options.

getDefaultItemId

Props

name	type	default value	description
toPrecision*	(precision?: number) => string	-	Returns a string containing a number represented either in exponential or fixed-point notation with a specified number of digits. @param precision Number of significant digits. Must be in the range 1 - 21, inclusive.
toExponential*	(fractionDigits?: number) => string	-	Returns a string containing a number represented in exponential notation. @param fractionDigits Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.
toFixed*	(fractionDigits?: number) => string	-	Returns a string representing a number in fixed-point notation. @param fractionDigits Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.
__@iterator@1249*	() => IterableIterator<string>	-	Iterator
toWellFormed*	() => string	-	Returns a string where all lone or out-of-order surrogates have been replaced by the Unicode replacement character (U+FFFD).
isWellFormed*	() => boolean	-	Returns true if all leading surrogates and trailing surrogates appear paired and in order.
at*	(index: number) => string	-	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.
replaceAll*	{ (searchValue: string | RegExp, replaceValue: string): string; (searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string): string; }	-	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.
matchAll*	(regexp: RegExp) => IterableIterator<RegExpExecArray>	-	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.
trimRight*	() => string	-	Removes the trailing white space and line terminator characters from a string. @deprecated A legacy feature for browser compatibility. Use trimEnd instead
trimLeft*	() => string	-	Removes the leading white space and line terminator characters from a string. @deprecated A legacy feature for browser compatibility. Use trimStart instead
trimStart*	() => string	-	Removes the leading white space and line terminator characters from a string.
trimEnd*	() => string	-	Removes the trailing white space and line terminator characters from a string.
padEnd*	(maxLength: number, fillString?: string) => string	-	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).
padStart*	(maxLength: number, fillString?: string) => string	-	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).
sup*	() => string	-	Returns a <sup> HTML element @deprecated A legacy feature for browser compatibility
sub*	() => string	-	Returns a <sub> HTML element @deprecated A legacy feature for browser compatibility
strike*	() => string	-	Returns a <strike> HTML element @deprecated A legacy feature for browser compatibility
small*	() => string	-	Returns a <small> HTML element @deprecated A legacy feature for browser compatibility
link*	(url: string) => string	-	Returns an <a> HTML element and sets the href attribute value @deprecated A legacy feature for browser compatibility
italics*	() => string	-	Returns an <i> HTML element @deprecated A legacy feature for browser compatibility
fontsize*	{ (size: number): string; (size: string): string; }	-	Returns a <font> HTML element and sets the size attribute value @deprecated A legacy feature for browser compatibility @deprecated A legacy feature for browser compatibility
fontcolor*	(color: string) => string	-	Returns a <font> HTML element and sets the color attribute value @deprecated A legacy feature for browser compatibility
fixed*	() => string	-	Returns a <tt> HTML element @deprecated A legacy feature for browser compatibility
bold*	() => string	-	Returns a <b> HTML element @deprecated A legacy feature for browser compatibility
blink*	() => string	-	Returns a <blink> HTML element @deprecated A legacy feature for browser compatibility
big*	() => string	-	Returns a <big> HTML element @deprecated A legacy feature for browser compatibility
anchor*	(name: string) => string	-	Returns an <a> HTML anchor element and sets the name attribute to the text value @deprecated A legacy feature for browser compatibility @param name
startsWith*	(searchString: string, position?: number) => boolean	-	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.
repeat*	(count: number) => string	-	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
normalize*	{ (form: "NFC" | "NFD" | "NFKC" | "NFKD"): string; (form?: string): string; }	-	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"
endsWith*	(searchString: string, endPosition?: number) => boolean	-	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.
includes*	(searchString: string, position?: number) => boolean	-	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.
codePointAt*	(pos: number) => number	-	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.
substr*	(from: number, length?: number) => string	-	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.
length*	number	-	Returns the length of a String object.
trim*	() => string	-	Removes the leading and trailing white space and line terminator characters from a string.
toLocaleUpperCase*	{ (locales?: string | string[]): string; (locales?: LocalesArgument): string; }	-	Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.
toUpperCase*	() => string	-	Converts all the alphabetic characters in a string to uppercase.
toLocaleLowerCase*	{ (locales?: string | string[]): string; (locales?: LocalesArgument): string; }	-	Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.
toLowerCase*	() => string	-	Converts all the alphabetic characters in a string to lowercase.
substring*	(start: number, end?: number) => string	-	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.
split*	{ (separator: string | RegExp, limit?: number): string[]; (splitter: { [Symbol.split](string: string, limit?: number): string[]; }, limit?: number): string[]; }	-	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.
slice*	(start?: number, end?: number) => string	-	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.
search*	{ (regexp: string | RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }	-	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.
replace*	{ (searchValue: string | RegExp, replaceValue: string): string; (searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }	-	Replaces text in a string, using a regular expression or search string. Passes a string and {@linkcode replaceValue} to the [Symbol.replace] method on {@linkcode searchValue}. This method is expected to implement its own replacement algorithm. Replaces text in a string, using an object that supports replacement within a string. @param searchValue A string or regular expression to search for. @param replaceValue A string containing the text to replace. When the {@linkcode searchValue } is a RegExp, all matches are replaced if the g flag is set (or only those matches at the beginning, if the y flag is also present). Otherwise, only the first match of {@linkcode searchValue } is replaced. @param searchValue A string to search for. @param replacer A function that returns the replacement text. @param searchValue An object that supports searching for and replacing matches within a string. @param replaceValue The replacement text. @param searchValue A object can search for and replace matches within a string. @param replacer A function that returns the replacement text.
match*	{ (regexp: string | RegExp): RegExpMatchArray; (matcher: { [Symbol.match](string: string): RegExpMatchArray; }): RegExpMatchArray; }	-	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.
localeCompare*	{ (that: string): number; (that: string, locales?: string | string[], options?: CollatorOptions): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions): number; }	-	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. @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.
lastIndexOf*	(searchString: string, position?: number) => number	-	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.
indexOf*	(searchString: string, position?: number) => number	-	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.
concat*	(...strings: string[]) => string	-	Returns a string that contains the concatenation of two or more strings. @param strings The strings to append to the end of the string.
charCodeAt*	(index: number) => number	-	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.
charAt*	(pos: number) => string	-	Returns the character at the specified index. @param pos The zero-based index of the desired character.
toString	(() => string) | ((radix?: number) => string)	function toString() { [native code] }	Returns a string representation of a string. Returns a string representation of an object. @param radix Specifies a radix for converting numeric values to strings. This value is only used for numbers.
valueOf	(() => string) | (() => number)	function valueOf() { [native code] }	Returns the primitive value of the specified object.
toLocaleString	(() => string) | { (locales?: string | string[], options?: NumberFormatOptions): string; (locales?: LocalesArgument, options?: NumberFormatOptions): string; }	function toLocaleString() { [native code] }	Returns a date converted to a string using the current locale. Converts a number to a string by using the current or specified locale. @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. @param options An object that contains one or more properties that specify comparison options. @param locales A locale string, array of locale strings, Intl.Locale object, or array of Intl.Locale objects 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. @param options An object that contains one or more properties that specify comparison options.