Skip to Content
πŸŽ‰ Coral x Panda has been released πŸŽ‰ Read the Migration Guide
DocumentationMapsCoralMapGeolocateControl

CoralMapGeolocateControl

CoralMapGeolocateControl provides a button that uses the browser’s geolocation API to locate the user on the map.

Import

import { CoralMapGeolocateControl } from '@krakentech/coral-maps';

Basic usage

<CoralMap mapboxAccessToken="..."> <CoralMapGeolocateControl /> </CoralMap>

Properties

Position

<CoralMap mapboxAccessToken="..."> <CoralMapGeolocateControl position="top-left" /> </CoralMap>

Size

<CoralMap mapboxAccessToken="..."> <CoralMapGeolocateControl size="large" /> </CoralMap>

Icon Size

<CoralMap mapboxAccessToken="..."> <CoralMapGeolocateControl iconSize="large" /> </CoralMap>

Color

<CoralMap mapboxAccessToken="..."> <CoralMapGeolocateControl color="secondary" /> </CoralMap>

Icon Color

<CoralMap mapboxAccessToken="..."> <CoralMapGeolocateControl iconColor="secondary" /> </CoralMap>

Variant

<CoralMap mapboxAccessToken="..."> <CoralMapGeolocateControl variant="outline" /> </CoralMap>

Full API

NameTypeDefault
childrenReactNode
attributesAttributes

This prop can be used to pass HTML attributes directly to the component. We currently allow passing data-* and aria-* attributes and the id. However, you can pass anything else with a type hack if necessary since this object is despread in to the component, without filtering its content.

Example usage:

AttributesProps: { 'id': 'close-button', 'aria-label': 'Close button', 'data-testid': 'close-button' };
defaultCheckedboolean | undefined
defaultValuestring | number | readonly string[] | undefined
suppressContentEditableWarningboolean | undefined
suppressHydrationWarningboolean | undefined
accessKeystring | undefined
autoFocusboolean | undefined
contentEditableBooleanish | "inherit" | undefined
contextMenustring | undefined
dirstring | undefined
draggableBooleanish | undefined
hiddenboolean | undefined
idstring | undefined
langstring | undefined
noncestring | undefined
placeholderstring | undefined
slotstring | undefined
spellCheckBooleanish | undefined
styleCSSProperties | undefined
tabIndexnumber | undefined
titlestring | undefined
translate"yes" | "no" | undefined
radioGroupstring | undefined
roleAriaRole | undefined
aboutstring | undefined
contentstring | undefined
datatypestring | undefined
inlistany
prefixstring | undefined
propertystring | undefined
relstring

The relationship of the linked URL as a space-separated link types, e.g. β€˜noopener noreferrer’.

resourcestring | undefined
revstring | undefined
typeofstring | undefined
vocabstring | undefined
autoCapitalizestring | undefined
autoCorrectstring | undefined
autoSavestring | undefined
itemPropstring | undefined
itemScopeboolean | undefined
itemTypestring | undefined
itemIDstring | undefined
itemRefstring | undefined
resultsnumber | undefined
securitystring | undefined
unselectable"on" | "off" | undefined
inputMode"none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined

Hints at the type of data that might be entered by the user while editing the element or its contents

isstring | undefined

Specify that a standard HTML element should behave like a defined custom built-in element

aria-activedescendantstring | undefined

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

aria-atomicBooleanish | undefined

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

aria-autocomplete"list" | "none" | "inline" | "both" | undefined

Indicates whether inputting text could trigger display of one or more predictions of the user’s intended value for an input and specifies how predictions would be presented if they are made.

aria-braillelabelstring | undefined

Defines a string value that labels the current element, which is intended to be converted into Braille.

aria-brailleroledescriptionstring | undefined

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

aria-busyBooleanish | undefined
aria-checkedboolean | "true" | "false" | "mixed" | undefined

Indicates the current β€œchecked” state of checkboxes, radio buttons, and other widgets.

aria-colcountnumber | undefined

Defines the total number of columns in a table, grid, or treegrid.

aria-colindexnumber | undefined

Defines an element’s column index or position with respect to the total number of columns within a table, grid, or treegrid.

aria-colindextextstring | undefined

Defines a human readable text alternative of aria-colindex.

aria-colspannumber | undefined

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

aria-controlsstring | undefined

Identifies the element (or elements) whose contents or presence are controlled by the current element.

aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | undefined

Indicates the element that represents the current item within a container or set of related elements.

aria-describedbystring | undefined

Identifies the element (or elements) that describes the object.

aria-descriptionstring | undefined

Defines a string value that describes or annotates the current element.

aria-detailsstring | undefined

Identifies the element that provides a detailed, extended description for the object.

aria-disabledBooleanish | undefined

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup" | undefined

Indicates what functions can be performed when a dragged object is released on the drop target. Deprecated: in ARIA 1.1

aria-errormessagestring | undefined

Identifies the element that provides an error message for the object.

aria-expandedBooleanish | undefined

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

aria-flowtostring | undefined

Identifies the next element (or elements) in an alternate reading order of content which, at the user’s discretion, allows assistive technology to override the general default of reading in document source order.

aria-grabbedBooleanish | undefined

Indicates an element’s β€œgrabbed” state in a drag-and-drop operation. Deprecated: in ARIA 1.1

aria-haspopupboolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree" | undefined

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

aria-hiddenBooleanish | undefined

Indicates whether the element is exposed to an accessibility API.

aria-invalidboolean | "true" | "false" | "grammar" | "spelling" | undefined

Indicates the entered value does not conform to the format expected by the application.

aria-keyshortcutsstring | undefined

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

aria-labelstring | undefined

Defines a string value that labels the current element.

aria-labelledbystring | undefined

Identifies the element (or elements) that labels the current element.

aria-levelnumber | undefined

Defines the hierarchical level of an element within a structure.

aria-live"off" | "assertive" | "polite" | undefined

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

aria-modalBooleanish | undefined

Indicates whether an element is modal when displayed.

aria-multilineBooleanish | undefined

Indicates whether a text box accepts multiple lines of input or only a single line.

aria-multiselectableBooleanish | undefined

Indicates that the user may select more than one item from the current selectable descendants.

aria-orientation"horizontal" | "vertical" | undefined

Indicates whether the element’s orientation is horizontal, vertical, or unknown/ambiguous.

aria-ownsstring | undefined

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

aria-placeholderstring | undefined

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

aria-posinsetnumber | undefined

Defines an element’s number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

aria-pressedboolean | "true" | "false" | "mixed" | undefined

Indicates the current β€œpressed” state of toggle buttons.

aria-readonlyBooleanish | undefined

Indicates that the element is not editable, but is otherwise operable.

aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | undefined

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

aria-requiredBooleanish | undefined

Indicates that user input is required on the element before a form may be submitted.

aria-roledescriptionstring | undefined

Defines a human-readable, author-localized description for the role of an element.

aria-rowcountnumber | undefined

Defines the total number of rows in a table, grid, or treegrid.

aria-rowindexnumber | undefined

Defines an element’s row index or position with respect to the total number of rows within a table, grid, or treegrid.

aria-rowindextextstring | undefined

Defines a human readable text alternative of aria-rowindex.

aria-rowspannumber | undefined

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

aria-selectedBooleanish | undefined

Indicates the current β€œselected” state of various widgets.

aria-setsizenumber | undefined

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

aria-sort"none" | "ascending" | "descending" | "other" | undefined

Indicates if items in a table or grid are sorted in ascending or descending order.

aria-valuemaxnumber | undefined

Defines the maximum allowed value for a range widget.

aria-valueminnumber | undefined

Defines the minimum allowed value for a range widget.

aria-valuenownumber | undefined

Defines the current value for a range widget.

aria-valuetextstring | undefined

Defines the human readable text alternative of aria-valuenow for a range widget.

dangerouslySetInnerHTML{ __html: string | TrustedHTML; } | undefined
onCopyClipboardEventHandler<HTMLButtonElement> | ClipboardEventHandler<HTMLAnchorElement> | undefined
onCopyCaptureClipboardEventHandler<HTMLButtonElement> | ClipboardEventHandler<HTMLAnchorElement> | undefined
onCutClipboardEventHandler<HTMLButtonElement> | ClipboardEventHandler<HTMLAnchorElement> | undefined
onCutCaptureClipboardEventHandler<HTMLButtonElement> | ClipboardEventHandler<HTMLAnchorElement> | undefined
onPasteClipboardEventHandler<HTMLButtonElement> | ClipboardEventHandler<HTMLAnchorElement> | undefined
onPasteCaptureClipboardEventHandler<HTMLButtonElement> | ClipboardEventHandler<HTMLAnchorElement> | undefined
onCompositionEndCompositionEventHandler<HTMLButtonElement> | CompositionEventHandler<HTMLAnchorElement> | undefined
onCompositionEndCaptureCompositionEventHandler<HTMLButtonElement> | CompositionEventHandler<HTMLAnchorElement> | undefined
onCompositionStartCompositionEventHandler<HTMLButtonElement> | CompositionEventHandler<HTMLAnchorElement> | undefined
onCompositionStartCaptureCompositionEventHandler<HTMLButtonElement> | CompositionEventHandler<HTMLAnchorElement> | undefined
onCompositionUpdateCompositionEventHandler<HTMLButtonElement> | CompositionEventHandler<HTMLAnchorElement> | undefined
onCompositionUpdateCaptureCompositionEventHandler<HTMLButtonElement> | CompositionEventHandler<HTMLAnchorElement> | undefined
onFocusFocusEventHandler<HTMLButtonElement> | FocusEventHandler<HTMLAnchorElement> | undefined
onFocusCaptureFocusEventHandler<HTMLButtonElement> | FocusEventHandler<HTMLAnchorElement> | undefined
onBlurFocusEventHandler<HTMLButtonElement> | FocusEventHandler<HTMLAnchorElement> | undefined
onBlurCaptureFocusEventHandler<HTMLButtonElement> | FocusEventHandler<HTMLAnchorElement> | undefined
onChangeFormEventHandler<HTMLButtonElement> | FormEventHandler<HTMLAnchorElement> | undefined
onChangeCaptureFormEventHandler<HTMLButtonElement> | FormEventHandler<HTMLAnchorElement> | undefined
onBeforeInputFormEventHandler<HTMLButtonElement> | FormEventHandler<HTMLAnchorElement> | undefined
onBeforeInputCaptureFormEventHandler<HTMLButtonElement> | FormEventHandler<HTMLAnchorElement> | undefined
onInputFormEventHandler<HTMLButtonElement> | FormEventHandler<HTMLAnchorElement> | undefined
onInputCaptureFormEventHandler<HTMLButtonElement> | FormEventHandler<HTMLAnchorElement> | undefined
onResetFormEventHandler<HTMLButtonElement> | FormEventHandler<HTMLAnchorElement> | undefined
onResetCaptureFormEventHandler<HTMLButtonElement> | FormEventHandler<HTMLAnchorElement> | undefined
onSubmitFormEventHandler<HTMLButtonElement> | FormEventHandler<HTMLAnchorElement> | undefined
onSubmitCaptureFormEventHandler<HTMLButtonElement> | FormEventHandler<HTMLAnchorElement> | undefined
onInvalidFormEventHandler<HTMLButtonElement> | FormEventHandler<HTMLAnchorElement> | undefined
onInvalidCaptureFormEventHandler<HTMLButtonElement> | FormEventHandler<HTMLAnchorElement> | undefined
onLoadReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onLoadCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onErrorReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onErrorCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onKeyDownKeyboardEventHandler<HTMLButtonElement> | KeyboardEventHandler<HTMLAnchorElement> | undefined
onKeyDownCaptureKeyboardEventHandler<HTMLButtonElement> | KeyboardEventHandler<HTMLAnchorElement> | undefined
onKeyPressKeyboardEventHandler<HTMLButtonElement> | KeyboardEventHandler<HTMLAnchorElement> | undefined
onKeyPressCaptureKeyboardEventHandler<HTMLButtonElement> | KeyboardEventHandler<HTMLAnchorElement> | undefined
onKeyUpKeyboardEventHandler<HTMLButtonElement> | KeyboardEventHandler<HTMLAnchorElement> | undefined
onKeyUpCaptureKeyboardEventHandler<HTMLButtonElement> | KeyboardEventHandler<HTMLAnchorElement> | undefined
onAbortReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onAbortCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onCanPlayReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onCanPlayCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onCanPlayThroughReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onCanPlayThroughCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onDurationChangeReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onDurationChangeCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onEmptiedReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onEmptiedCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onEncryptedReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onEncryptedCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onEndedReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onEndedCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onLoadedDataReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onLoadedDataCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onLoadedMetadataReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onLoadedMetadataCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onLoadStartReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onLoadStartCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onPauseReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onPauseCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onPlayReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onPlayCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onPlayingReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onPlayingCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onProgressReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onProgressCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onRateChangeReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onRateChangeCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onResizeReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onResizeCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onSeekedReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onSeekedCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onSeekingReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onSeekingCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onStalledReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onStalledCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onSuspendReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onSuspendCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onTimeUpdateReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onTimeUpdateCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onVolumeChangeReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onVolumeChangeCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onWaitingReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onWaitingCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onAuxClickMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onAuxClickCaptureMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onClickCaptureMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onContextMenuMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onContextMenuCaptureMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onDoubleClickMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onDoubleClickCaptureMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onDragDragEventHandler<HTMLButtonElement> | DragEventHandler<HTMLAnchorElement> | undefined
onDragCaptureDragEventHandler<HTMLButtonElement> | DragEventHandler<HTMLAnchorElement> | undefined
onDragEndDragEventHandler<HTMLButtonElement> | DragEventHandler<HTMLAnchorElement> | undefined
onDragEndCaptureDragEventHandler<HTMLButtonElement> | DragEventHandler<HTMLAnchorElement> | undefined
onDragEnterDragEventHandler<HTMLButtonElement> | DragEventHandler<HTMLAnchorElement> | undefined
onDragEnterCaptureDragEventHandler<HTMLButtonElement> | DragEventHandler<HTMLAnchorElement> | undefined
onDragExitDragEventHandler<HTMLButtonElement> | DragEventHandler<HTMLAnchorElement> | undefined
onDragExitCaptureDragEventHandler<HTMLButtonElement> | DragEventHandler<HTMLAnchorElement> | undefined
onDragLeaveDragEventHandler<HTMLButtonElement> | DragEventHandler<HTMLAnchorElement> | undefined
onDragLeaveCaptureDragEventHandler<HTMLButtonElement> | DragEventHandler<HTMLAnchorElement> | undefined
onDragOverDragEventHandler<HTMLButtonElement> | DragEventHandler<HTMLAnchorElement> | undefined
onDragOverCaptureDragEventHandler<HTMLButtonElement> | DragEventHandler<HTMLAnchorElement> | undefined
onDragStartDragEventHandler<HTMLButtonElement> | DragEventHandler<HTMLAnchorElement> | undefined
onDragStartCaptureDragEventHandler<HTMLButtonElement> | DragEventHandler<HTMLAnchorElement> | undefined
onDropDragEventHandler<HTMLButtonElement> | DragEventHandler<HTMLAnchorElement> | undefined
onDropCaptureDragEventHandler<HTMLButtonElement> | DragEventHandler<HTMLAnchorElement> | undefined
onMouseDownMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onMouseDownCaptureMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onMouseEnterMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onMouseLeaveMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onMouseMoveMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onMouseMoveCaptureMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onMouseOutMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onMouseOutCaptureMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onMouseOverMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onMouseOverCaptureMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onMouseUpMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onMouseUpCaptureMouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLAnchorElement> | undefined
onSelectReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onSelectCaptureReactEventHandler<HTMLButtonElement> | ReactEventHandler<HTMLAnchorElement> | undefined
onTouchCancelTouchEventHandler<HTMLButtonElement> | TouchEventHandler<HTMLAnchorElement> | undefined
onTouchCancelCaptureTouchEventHandler<HTMLButtonElement> | TouchEventHandler<HTMLAnchorElement> | undefined
onTouchEndTouchEventHandler<HTMLButtonElement> | TouchEventHandler<HTMLAnchorElement> | undefined
onTouchEndCaptureTouchEventHandler<HTMLButtonElement> | TouchEventHandler<HTMLAnchorElement> | undefined
onTouchMoveTouchEventHandler<HTMLButtonElement> | TouchEventHandler<HTMLAnchorElement> | undefined
onTouchMoveCaptureTouchEventHandler<HTMLButtonElement> | TouchEventHandler<HTMLAnchorElement> | undefined
onTouchStartTouchEventHandler<HTMLButtonElement> | TouchEventHandler<HTMLAnchorElement> | undefined
onTouchStartCaptureTouchEventHandler<HTMLButtonElement> | TouchEventHandler<HTMLAnchorElement> | undefined
onPointerDownPointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onPointerDownCapturePointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onPointerMovePointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onPointerMoveCapturePointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onPointerUpPointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onPointerUpCapturePointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onPointerCancelPointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onPointerCancelCapturePointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onPointerEnterPointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onPointerEnterCapturePointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onPointerLeavePointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onPointerLeaveCapturePointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onPointerOverPointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onPointerOverCapturePointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onPointerOutPointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onPointerOutCapturePointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onGotPointerCapturePointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onGotPointerCaptureCapturePointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onLostPointerCapturePointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onLostPointerCaptureCapturePointerEventHandler<HTMLButtonElement> | PointerEventHandler<HTMLAnchorElement> | undefined
onScrollUIEventHandler<HTMLButtonElement> | UIEventHandler<HTMLAnchorElement> | undefined
onScrollCaptureUIEventHandler<HTMLButtonElement> | UIEventHandler<HTMLAnchorElement> | undefined
onWheelWheelEventHandler<HTMLButtonElement> | WheelEventHandler<HTMLAnchorElement> | undefined
onWheelCaptureWheelEventHandler<HTMLButtonElement> | WheelEventHandler<HTMLAnchorElement> | undefined
onAnimationStartAnimationEventHandler<HTMLButtonElement> | AnimationEventHandler<HTMLAnchorElement> | undefined
onAnimationStartCaptureAnimationEventHandler<HTMLButtonElement> | AnimationEventHandler<HTMLAnchorElement> | undefined
onAnimationEndAnimationEventHandler<HTMLButtonElement> | AnimationEventHandler<HTMLAnchorElement> | undefined
onAnimationEndCaptureAnimationEventHandler<HTMLButtonElement> | AnimationEventHandler<HTMLAnchorElement> | undefined
onAnimationIterationAnimationEventHandler<HTMLButtonElement> | AnimationEventHandler<HTMLAnchorElement> | undefined
onAnimationIterationCaptureAnimationEventHandler<HTMLButtonElement> | AnimationEventHandler<HTMLAnchorElement> | undefined
onTransitionEndTransitionEventHandler<HTMLButtonElement> | TransitionEventHandler<HTMLAnchorElement> | undefined
onTransitionEndCaptureTransitionEventHandler<HTMLButtonElement> | TransitionEventHandler<HTMLAnchorElement> | undefined
color"primary500" | "secondary500" | "base100" | undefined

The colourway applied to this component.

primary500
disabledboolean

If true, the component will be disabled and not respond to user interactions.

false
downloadstring | boolean

If true, the component will be downloaded when clicked. If a string is passed, it will be used as the filename for the download.

false
endIconReactNode

Display an Icon after the button text content. See also startIcon.

fullWidthResponsiveVariant<boolean>

If true, the button will take up the full width of its container.

false
fullHeightResponsiveVariant<boolean>

If true, the button will take up the full height of its container.

false
hrefstring

Supply an href to turn this button into a semantic anchor element, for links and routing.

loadingboolean

If true, the button will be in a loading state and will not respond to user interactions.

false
loadingLabelReactNode

The label to display when the button is in a loading state.

Loading...
onClickMouseEventHandler<HTMLButtonElement | HTMLAnchorElement>

Callback fired when clicking the button.

startIconReactNode

Display an Icon before the button text content. See also endIcon

target"_self" | "_blank" | "_parent" | "_top"

The target window or tab for the link.

type"button" | "submit" | "reset"

The type of the button.

button
variant"link" | "text" | "contained" | "ghost" | "outlined" | undefined

The variant of the button.

contained
size"xs" | "small" | "medium" | "large" | undefined

The size of the button, which affects its padding.

medium
tostring

The URL to navigate to when the button is clicked, if it is an anchor element, used with React Router.

ignoreLinkComponentboolean

If true, the button will not use the CoralThemeConfig router for navigation, and will instead behave like a normal anchor tag.

false
iconColorstring | undefined

The color of the control icon

duotone
iconSizenumber | undefined

The size of the control icon

18
position"top-left" | "top-right" | "bottom-left" | "bottom-right"

The position of the control on the map

top-right
Last updated on