Package com.vaadin.flow.component.details

Class Details

  • All Implemented Interfaces:
    AttachNotifier, DetachNotifier, HasElement, HasEnabled, HasSize, HasStyle, HasTheme, Serializable
    Direct Known Subclasses:
    AccordionPanel
    @Tag("vaadin-details")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="23.1.13") @NpmPackage(value="@vaadin/details",version="23.1.13") @NpmPackage(value="@vaadin/vaadin-details",version="23.1.13")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/details/src/vaadin-details.js")
public class Details
extends Component
implements HasEnabled, HasTheme, HasStyle, HasSize
    Details is an expandable panel for showing and hiding content from the user to make the UI less crowded. Details consists of a summary and a content area.

    The Summary is the part that is always visible, and typically describes the contents, for example, with a title. Clicking on the summary toggles the content area’s visibility. The summary supports rich content and can contain any component. This can be utilized for example to indicate the status of the corresponding content.

    The content area is the collapsible part of Details. It can contain any component. When the content area is collapsed, the content is invisible and inaccessible by keyboard or screen reader.

    Author:
    Vaadin Ltd
    See Also:
    Serialized Form

    • Constructor Detail

      • Details

        public Details()
        Initializes a new Details component.

      • Details

        public Details​(String summary)
        Initializes a new Details using the provided summary.
        Parameters:
        summary - the summary component to set.
        See Also:
        setSummaryText(String)

      • Details

        public Details​(Component summary)
        Initializes a new Details using the provided summary.
        Parameters:
        summary - the summary component to set.
        See Also:
        setSummary(Component)

    • Method Detail

      • setSummary

        public void setSummary​(Component summary)
        Sets the component summary
        Parameters:
        summary - the summary component to set, or null to remove any previously set summary
        See Also:
        getSummary()

      • getSummaryText

        public String getSummaryText()
        Returns:
        summary section content as string (empty string if nothing was set)

      • setContent

        public void setContent​(Component content)
        Sets the component content
        Parameters:
        content - the content of the component to set, or null to remove any previously set content
        See Also:
        getContent()

      • addContent

        public void addContent​(Component... components)
        Adds components to the content section
        Parameters:
        components - the components to add
        See Also:
        getContent()

      • setOpened

        public void setOpened​(boolean opened)

        True if the details are opened and the content is displayed

        Parameters:
        opened - the boolean value to set

      • addThemeVariants

        public void addThemeVariants​(DetailsVariant... variants)
        Adds theme variants to the component.
        Parameters:
        variants - theme variants to add

      • removeThemeVariants

        public void removeThemeVariants​(DetailsVariant... variants)
        Removes theme variants from the component.
        Parameters:
        variants - theme variants to remove