@lwc/style-compiler
Version:
Transform style sheet to be consumed by the LWC engine
41 lines • 1.45 kB
TypeScript
/** Configuration options for CSS transforms. */
export interface Config {
/**
* CSS custom properties configuration
* @deprecated Custom property transforms are deprecated because IE11 and other legacy browsers are no longer supported.
*/
customProperties?: {
/** Name of the module to resolve custom properties lookup */
resolverModule?: string;
};
/** Token that is used for scoping in light DOM scoped styles */
scoped?: boolean;
/** When set to true, synthetic shadow DOM support is removed from the output JavaScript */
disableSyntheticShadowSupport?: boolean;
/** The API version to associate with the compiled stylesheet */
apiVersion?: number;
/** When set to true, enables error recovery mode to collect multiple errors */
experimentalErrorRecoveryMode?: boolean;
}
/**
* Transforms CSS for use with LWC components.
* @param src Contents of the CSS source file
* @param id Filename of the CSS source file
* @param config Transformation options
* @returns Transformed CSS
* @example
* import { transform } from '@lwc/style-compiler';
* const source = `
* :host {
* opacity: 0.4;
* }
* span {
* text-transform: uppercase;
* }`;
* const { code } = transform(source, 'example.css');
*/
export declare function transform(src: string, id: string, config?: Config): {
code: string;
errors?: Error[];
};
//# sourceMappingURL=transform.d.ts.map