Tip

deprecated in v2.9Refer to the Carousel component documentation.
Learn more

Overview

Tip is a simple solution for short content that can be supported with an image. Tips can be dismissible or non-dismissible. Tip is optimized to work with Tip Manager and Tip Group for a paginated series of content.

Consider Notice for inline helpers or hints.

For hover-generated helpers, please consider Tooltip.

Usage

  • Provide high-level onboarding that does not need to be inline.

Sample

1
2
3
4
5
<calcite-tip heading="Example tip title">
    <img slot="thumbnail" src="https://placebear.com/1000/600" alt="A bear in its natural habitat.">
    <p>Description lorem ipsum dolor sit amet quis nostrud exercitation consectetur adipiscing elit.</p>
    <calcite-link href="http://www.esri.com">An example link</calcite-link>
</calcite-tip>
v3.0.3

Accessibility

Keyboard navigation

KeyFunction
TabMove focus to next item within element. If the current focus is the last item, the focus will cycle to the first item
Tab and ShiftMove focus to previous item within element. If the current focus is the first item, the focus will cycle to the last item

API reference

Properties

PropertyAttributeDescriptionTypeDefault
closedclosedWhen true, the component does not display.booleanfalse
closeDisabledclose-disabledWhen true, the close button is not present on the component.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
messageOverridesUse this property to override individual strings used by the component.{ close?: string; }
selectedselectedWhen true, the component is selected if it has a parent calcite-tip-manager. Only one tip can be selected within the calcite-tip-manager parent.booleanfalse

Slots

NameDescription
default (unnamed)A slot for adding text and a hyperlink.
thumbnailA slot for adding an HTML image element.

Events

NameDescriptionBehavior
calciteTipDismissEmits when the component has been closed.bubblescomposed

Methods

NameDescriptionSignature
componentOnReadyCreate a promise that resolves once component is fully loaded.componentOnReady(): 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