scoped An overlay that can be used to indicate activity while blocking user interaction. The loading indicator appears on top of the app's content, and can be dismissed by the app to resume user interaction with the app. It includes an optional backdrop, which can be disabled by setting showBackdrop: false
upon creation.
Basic Usageโ Once presented, the loading indicator will display indefinitely by default. Developers can manually dismiss the loading indicator after creation by calling the dismiss()
method on the component. The onDidDismiss
function can be called to perform an action after the loading indicator is dismissed.
Alternatively, developers can configure the loading indicator to dismiss automatically after a specific amount of time by passing the number of milliseconds to display it in the duration
of the loading options.
Controllerโ Navify React and Navify Kdu users also have the option to use the nav-loading
component directly in their template.
import React , { useState } from 'react' ; import { NavLoading , NavButton , NavContent } from '@navify/react' ; export const LoadingExample : React . FC = ( ) => { const [ showLoading , setShowLoading ] = useState ( false ) ; return ( < NavContent > < NavButton onClick = { ( ) => setShowLoading ( true ) } > Show Loading </ NavButton > < NavLoading cssClass = ' my-custom-class ' isOpen = { showLoading } onDidDismiss = { ( ) => setShowLoading ( false ) } message = { 'Please wait...' } duration = { 5000 } /> </ NavContent > ) ; } ;
Copy < template > < nav-content > < nav-button @click = " setOpen(true) " > Show Loading </ nav-button > < nav-loading :is-open = " isOpenRef " cssClass = " my-custom-class " message = " Please wait... " :duration = " timeout " @didDismiss = " setOpen(false) " > </ nav-loading > </ nav-content > </ template > < script lang = " ts " > import { NavButton , NavContent , NavLoading } from '@navify/kdu' ; import { defineComponent , ref } from 'kdu' ; export default defineComponent ( { props : { timeout : { type : Number , default : 1000 } , } , components : { NavButton , NavContent , NavLoading } , setup ( ) { const isOpenRef = ref ( false ) ; const setOpen = ( state : boolean ) => isOpenRef . value = state ; return { isOpenRef , setOpen } } } ) ; </ script >
Copy Customizationโ Spinnersโ The spinner that is used can be customized using the spinner
property. See the spinner property documentation for a full list of options.
Themingโ Loading uses scoped encapsulation, which means it will automatically scope its CSS by appending each of the styles with an additional class at runtime. Overriding scoped selectors in CSS requires a higher specificity selector.
We recommend passing a custom class and using that to add custom styles to the host and inner elements.
nav-loading
is presented at the root of your application, so we recommend placing any nav-loading
styles in a global stylesheet.
Accessibilityโ Navify automatically sets Loading's role
to dialog
.
If the message
property is defined for Loading, then the aria-labelledby
attribute will be automatically set to the message element's ID. Otherwise, aria-labelledby
will not be set, and developers must provide an aria-label
using the htmlAttributes
property.
All ARIA attributes can be manually overwritten by defining custom values in the htmlAttributes
property of Loading.
Interfacesโ LoadingOptionsโ interface LoadingOptions { spinner ? : SpinnerTypes | null ; message ? : string | NavifySafeString ; cssClass ? : string | string [ ] ; showBackdrop ? : boolean ; duration ? : number ; translucent ? : boolean ; animated ? : boolean ; backdropDismiss ? : boolean ; mode ? : Mode ; keyboardClose ? : boolean ; id ? : string ; htmlAttributes ? : { [ key : string ] : any } ; enterAnimation ? : AnimationBuilder ; leaveAnimation ? : AnimationBuilder ; }
Copy Propertiesโ animatedโ Description If true
, the loading indicator will animate. Attribute animated
Type boolean
Default true
backdropDismissโ Description If true
, the loading indicator will be dismissed when the backdrop is clicked. Attribute backdrop-dismiss
Type boolean
Default false
cssClassโ Description Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. Attribute css-class
Type string ๏ฝ string[] ๏ฝ undefined
Default undefined
durationโ Description Number of milliseconds to wait before dismissing the loading indicator. Attribute duration
Type number
Default 0
enterAnimationโ Description Animation to use when the loading indicator is presented. Attribute undefined
Type ((baseEl: any, opts?: any) => Animation) ๏ฝ undefined
Default undefined
htmlAttributesโ Description Additional attributes to pass to the loader. Attribute undefined
Type undefined ๏ฝ { [key: string]: any; }
Default undefined
keyboardCloseโ Description If true
, the keyboard will be automatically dismissed when the overlay is presented. Attribute keyboard-close
Type boolean
Default true
leaveAnimationโ Description Animation to use when the loading indicator is dismissed. Attribute undefined
Type ((baseEl: any, opts?: any) => Animation) ๏ฝ undefined
Default undefined
messageโ Description Optional text content to display in the loading indicator. Attribute message
Type NavifySafeString ๏ฝ string ๏ฝ undefined
Default undefined
Description The mode determines which platform styles to use. Attribute mode
Type "ios" ๏ฝ "md"
Default undefined
showBackdropโ Description If true
, a backdrop will be displayed behind the loading indicator. Attribute show-backdrop
Type boolean
Default true
spinnerโ Description The name of the spinner to display. Attribute spinner
Type "bubbles" ๏ฝ "circles" ๏ฝ "circular" ๏ฝ "crescent" ๏ฝ "dots" ๏ฝ "lines" ๏ฝ "lines-sharp" ๏ฝ "lines-sharp-small" ๏ฝ "lines-small" ๏ฝ null ๏ฝ undefined
Default undefined
translucentโ Description If true
, the loading indicator will be translucent. Only applies when the mode is "ios"
and the device supports backdrop-filter
. Attribute translucent
Type boolean
Default false
Name Description navLoadingDidDismiss
Emitted after the loading has dismissed. navLoadingDidPresent
Emitted after the loading has presented. navLoadingWillDismiss
Emitted before the loading has dismissed. navLoadingWillPresent
Emitted before the loading has presented.
Methodsโ dismissโ Description Dismiss the loading overlay after it has been presented. Signature dismiss(data?: any, role?: string) => Promise<boolean>
onDidDismissโ Description Returns a promise that resolves when the loading did dismiss. Signature onDidDismiss<T = any>() => Promise<OverlayEventDetail<T>>
onWillDismissโ Description Returns a promise that resolves when the loading will dismiss. Signature onWillDismiss<T = any>() => Promise<OverlayEventDetail<T>>
presentโ Description Present the loading overlay after it has been created. Signature present() => Promise<void>
CSS Shadow Partsโ No CSS shadow parts available for this component.
CSS Custom Propertiesโ Name Description --backdrop-opacity
Opacity of the backdrop --background
Background of the loading dialog --height
Height of the loading dialog --max-height
Maximum height of the loading dialog --max-width
Maximum width of the loading dialog --min-height
Minimum height of the loading dialog --min-width
Minimum width of the loading dialog --spinner-color
Color of the loading spinner --width
Width of the loading dialog
No slots available for this component.