lit-html/directives/classMap.d.ts

HTML template literals in JavaScript

/**
 * @license
 * Copyright (c) 2018 The Polymer Project Authors. All rights reserved.
 * This code may only be used under the BSD style license found at
 * http://polymer.github.io/LICENSE.txt
 * The complete set of authors may be found at
 * http://polymer.github.io/AUTHORS.txt
 * The complete set of contributors may be found at
 * http://polymer.github.io/CONTRIBUTORS.txt
 * Code distributed by Google as part of the polymer project is also
 * subject to an additional IP rights grant found at
 * http://polymer.github.io/PATENTS.txt
 */
import { Directive, AttributePart } from '../lit-html.js';
export interface ClassInfo {
    [name: string]: string | boolean | number;
}
/**
 * A directive that applies CSS classes. This must be used in the `class` attribute
 * and must be the only part used in the attribute. It takes each property in the
 * `classInfo` argument and adds the property name to the element's `classList`
 * if the property value is truthy; if the property value is falsey, the
 * property name is removed from the element's `classList`. For example
 * `{foo: bar}` applies the class `foo` if the value of `bar` is truthy.
 * @param classInfo {ClassInfo}
 */
export declare const classMap: (classInfo: ClassInfo) => Directive<AttributePart>;