Flow Item

Child component of Flow

Overview

Sample

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
<calcite-shell>
    <calcite-shell-panel slot="panel-start" width="l">
        <calcite-flow>
            <calcite-flow-item>
                <calcite-panel heading="Map Options">
                    <calcite-action icon="question" text="Favorite" slot="header-actions-start"></calcite-action>
                    <calcite-action icon="save" text="Save" slot="header-actions-end"></calcite-action>
                    <calcite-action icon="reset" text-enabled text="Reset" slot="header-menu-actions"></calcite-action>
                    <calcite-action icon="pencil" text-enabled text="Rename" slot="header-menu-actions">
                    </calcite-action>
                    <calcite-button width="half" slot="footer" appearance="outline">
                        Cancel
                    </calcite-button>
                    <calcite-button width="half" slot="footer">
                        Next
                    </calcite-button>
                    <calcite-block collapsible heading="Layer effects" description="Adjust blur, highlight, and more"
                        icon-start="effects">
                        <calcite-notice open>
                            <div slot="message">Use layer effects sparingly, for emphasis</div>
                        </calcite-notice>
                    </calcite-block>
                    <calcite-block collapsible heading="Symbology" description="Select type, color, and transparency"
                        icon-start="map-pin">
                        <calcite-notice open>
                            <div slot="message">The viewers are going to love this</div>
                        </calcite-notice>
                    </calcite-block>
                    <calcite-fab slot="fab"></calcite-fab>
                </calcite-panel>
            </calcite-flow-item>
        </calcite-flow>
    </calcite-shell-panel>
    <calcite-panel heading="Content"></calcite-panel>
</calcite-shell>
v3.0.3

API reference

Properties

PropertyAttributeDescriptionTypeDefault
beforeBackWhen provided, the method will be called before it is removed from its parent calcite-flow.() => Promise<void>
beforeClosePasses a function to run before the component closes.() => Promise<void>
closableclosableWhen true, displays a close button in the trailing side of the component's header.booleanfalse
closedclosedWhen true, the component will be hidden.booleanfalse
collapsedcollapsedWhen true, hides the component's content area.booleanfalse
collapsiblecollapsibleWhen true, the component is collapsible.booleanfalse
descriptiondescriptionA description for the component.string
disableddisabledWhen true, interaction is prevented and the component is displayed with lower opacity.booleanfalse
headingheadingThe component header text.string
headingLevelheading-levelSpecifies the heading level of the component's heading for proper document structure, without affecting visual styling.1 | 2 | 3 | 4 | 5 | 6
loadingloadingWhen true, a busy indicator is displayed.booleanfalse
menuOpenmenu-openWhen true, the action menu items in the header-menu-actions slot are open.booleanfalse
messageOverridesUse this property to override individual strings used by the component.{ back?: string; close?: string; options?: string; }
overlayPositioningoverlay-positioningDetermines the type of positioning to use for the overlaid content. Using "absolute" will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. "fixed" should be used to escape an overflowing parent container, or when the reference element's position CSS property is "fixed"."absolute" | "fixed""absolute"
scalescaleSpecifies the size of the component."l" | "m" | "s""m"
selectedselectedWhen true, flow-item is displayed within a parent flow.booleanfalse

Slots

NameDescription
default (unnamed)A slot for adding custom content.
action-barA slot for adding a calcite-action-bar to the component.
alertsA slot for adding calcite-alerts to the component.
content-topA slot for adding content above the unnamed (default) slot and below the action-bar slot (if populated).
content-bottomA slot for adding content below the unnamed (default) slot and above the footer slot (if populated)
header-actions-startA slot for adding calcite-actions or content to the start side of the component's header.
header-actions-endA slot for adding calcite-actions or content to the end side of the component's header.
header-contentA slot for adding custom content to the component's header.
header-menu-actionsA slot for adding an overflow menu with calcite-actions inside a calcite-dropdown.
fabA slot for adding a calcite-fab (floating action button) to perform an action.

Styles

NameDescription
--calcite-flow-item-header-border-block-end
deprecated Use --calcite-flow-border-color instead. Specifies the component header's block end border.
--calcite-flow-corner-radiusSpecifies the component's corner radius.
--calcite-flow-heading-text-colorSpecifies the text color of the component's heading.
--calcite-flow-description-text-colorSpecifies the text color of the component's description.
--calcite-flow-border-colorSpecifies the component's border color.
--calcite-flow-background-colorSpecifies the component's background color.
--calcite-flow-header-background-colorSpecifies the background color of the component's header.
--calcite-flow-spaceSpecifies the padding of the component's "unnamed (default)" slot.
--calcite-flow-header-content-spaceSpecifies the padding of the "header-content" slot.
--calcite-action-background-colorSpecifies the background color of the component's closable, collapsible, and back calcite-actions. Applies to any slotted calcite-actions.
--calcite-action-background-color-hoverSpecifies the background color of the component's closable, collapsible, and back calcite-actions when hovered. Applies to any slotted calcite-actions.
--calcite-action-background-color-pressedSpecifies the background color of the component's closable, collapsible, and back calcite-actions when pressed. Applies to any slotted calcite-actions.
--calcite-action-text-color-hoverSpecifies the text and icon color of the component's closable, collapsible, and back calcite-actions when hovered. Applies to any slotted calcite-actions.
--calcite-action-text-color-pressedSpecifies the text and icon color of the component's closable, collapsible, and back calcite-actions when pressed. Applies to any slotted calcite-actions.
--calcite-popover-border-colorSpecifies the border color of the component's internally rendered calcite-popover, which is rendered within a calcite-action menu when slotted calcite-actions are present in the header-actions-end slot. Applies to any slotted calcite-popovers.
--calcite-flow-header-action-background-color-hoverSpecifies the background color of the component's calcite-action items in the flow item header when hovered.
--calcite-flow-header-action-background-color-pressSpecifies the background color of the component's calcite-action items in the flow item header when pressed.
--calcite-flow-header-action-background-colorSpecifies the background color of the component's calcite-action items in the flow item header.
--calcite-flow-header-action-indicator-colorSpecifies the color of the component's calcite-action items' indicator in the flow item header.
--calcite-flow-header-action-text-color-pressSpecifies the text color of the component's calcite-action items in the flow item header when pressed.
--calcite-flow-header-action-text-colorSpecifies the text color of the component's calcite-action items in the flow item header.

Events

NameDescriptionBehavior
calciteFlowItemBackFires when the back button is clicked.bubblescomposedcancelable
calciteFlowItemCloseFires when the close button is clicked.bubblescomposed
calciteFlowItemScrollFires when the content is scrolled.bubblescomposed
calciteFlowItemToggleFires when the collapse button is clicked.bubblescomposed

Methods

NameDescriptionSignature
componentOnReadyCreate a promise that resolves once component is fully loaded.componentOnReady(): Promise<void>
scrollContentToScrolls the component's content to a specified set of coordinates.scrollContentTo(options?: ScrollToOptions): Promise<void>
setFocusSets focus on the component.setFocus(): Promise<void>

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close