view-transition-name
Version:
Generate css `view-transition-name`s
36 lines • 1.1 kB
TypeScript
import { customIdent } from "custom-ident";
export declare class ViewTransitionNameError extends Error {
constructor(message: string, options?: ErrorOptions);
}
export declare class ViewTransitionNameReservedKeywordError extends ViewTransitionNameError {
constructor(keyword: string);
}
/**
* Turns a list of values into a CSS <view-transition-name>.
* Escapes invalid characters.
*
* @warning Spaces are mapped to hyphens.
*
* @example
* ```ts
* import { viewTransitionName } from "view-transition-name";
*
* const ident = viewTransitionName("foo", "bar", "baz@");
* console.log(ident); // 'foo_bar_baz\\40'
*
* const ident = viewTransitionName([
* undefined,
* null,
* true,
* false,
* 3,
* { test: "hi", oof: 0 },
* ]);
* console.log(ident); // 'undefined_null_true_false_3_test'
* ```
*
* @param args - The values to be concatenated into a view-transition-name.
* @returns A string representing the view-transition-name.
*/
export declare function viewTransitionName(...args: Parameters<typeof customIdent>): string;
//# sourceMappingURL=index.d.ts.map