org.patternfly.component.avatar.Avatar Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of patternfly-java-components Show documentation

PatternFly Java components

There is a newer version: 0.2.11

Show newest version

/*
 *  Copyright 2023 Red Hat
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.patternfly.component.avatar;

import org.patternfly.component.BaseComponentFlat;
import org.patternfly.component.ComponentType;
import org.patternfly.style.Brightness;
import org.patternfly.style.Size;

import elemental2.dom.HTMLImageElement;

import static org.jboss.elemento.Elements.img;
import static org.patternfly.core.Validation.verifyEnum;
import static org.patternfly.style.Brightness.dark;
import static org.patternfly.style.Brightness.light;
import static org.patternfly.style.Classes.avatar;
import static org.patternfly.style.Classes.component;
import static org.patternfly.style.TypedModifier.swap;

/**
 * An avatar is a visual used to represent a user. It may contain an image or a placeholder graphic.
 *
 * @see https://www.patternfly.org/components/avatar
 */
public class Avatar extends BaseComponentFlat {

    // ------------------------------------------------------ factory

    public static Avatar avatar(String src, String alt) {
        return new Avatar(src, alt);
    }

    // ------------------------------------------------------ instance

    Avatar(String src, String alt) {
        super(ComponentType.Avatar, img().css(component(avatar)).apply(i -> {
            i.src = src;
            i.alt = alt;
        }).element());
    }

    // ------------------------------------------------------ builder

    public Avatar src(String src) {
        element().src = src;
        return this;
    }

    public Avatar alt(String alt) {
        element().alt = alt;
        return this;
    }

    public Avatar size(Size size) {
        return swap(this, element(), size, Size.values());
    }

    public Avatar border(Brightness border) {
        if (verifyEnum(element(), "border", border, light, dark)) {
            swap(this, element(), border, Brightness.values());
        }
        return this;
    }

    @Override
    public Avatar that() {
        return this;
    }
}