The ProgressButton visualizes the progression of an operation to indicate the user that a process is happening in the background with visual representation.
<button id="element"></button><script>
var progressButtonObj = new ProgressButton({ content: 'Progress Button' });
progressButtonObj.appendTo("#element");
</script>Specifies the animation settings.
string
Defines the text content of the progress button element.
Defaults to ""
string
Specifies the root CSS class of the progress button that allows customization of component’s appearance. The progress button types, styles, and size can be achieved by using this property.
Defaults to ""
boolean
Enables or disables the progress button.
Defaults to false.
number
Specifies the duration of progression in the progress button.
Defaults to 2000
boolean
Specifies whether to enable the rendering of untrusted HTML values in the Progress button component. If ‘enableHtmlSanitizer’ set to true, the component will sanitize any suspected untrusted strings and scripts before rendering them.
Defaults to true
boolean
Enable or disable persisting component’s state between page reloads.
Defaults to false
boolean
Enables or disables the background filler UI in the progress button.
Defaults to false
boolean
Enable or disable rendering component in right to left direction.
Defaults to false
string
Defines class/multiple classes separated by a space for the progress button that is used to include an icon. Progress button can also include font icon and sprite image.
Defaults to ""
string | IconPosition
Positions an icon in the progress button. The possible values are:
Defaults to Syncfusion.EJ2.Buttons.IconPosition.Left
boolean
Allows the appearance of the progress button to be enhanced and visually appealing when set to true.
Defaults to false
boolean
Makes the progress button toggle, when set to true. When you click it, the state changes from normal to active.
Defaults to false
Specifies a spinner and its related properties.
Adds the handler to the given event listener.
| Parameter | Type | Description |
|---|---|---|
| eventName | string |
A String that specifies the name of the event |
| handler | Function |
Specifies the call to run when the event occurs. |
Returns void
Appends the control within the given HTML element
| Parameter | Type | Description |
|---|---|---|
| selector (optional) | string | HTMLElement |
Target element where control needs to be appended |
Returns void
Adding unload event to persist data when enable persistence true
Returns void
Click the button element its native method
Returns void
When invoked, applies the pending property changes immediately to the component.
Returns void
Destroys the widget.
Returns void
Removing unload event to persist data when enable persistence true
Returns void
Sets the focus to ProgressButton its native method
Returns void
Returns the persistence data for component
Returns any
Returns the route element of the component
Returns HTMLElement
Handling unload event to persist data when enable persistence true
Returns void
Complete the button progress.
Returns void
Applies all the pending property changes and render the component again.
Returns void
Removes the handler from the given event listener.
| Parameter | Type | Description |
|---|---|---|
| eventName | string |
A String that specifies the name of the event to remove |
| handler | Function |
Specifies the function to remove |
Returns void
Starts the button progress at the specified percent.
| Parameter | Type | Description |
|---|---|---|
| percent (optional) | number |
Starts the button progress at this percent. |
Returns void
Stops the button progress.
Returns void
Triggers when the progress starts.
EmitType<Event>
Triggers once the component rendering is completed.
Triggers when the progress is completed.
EmitType<Event>
Triggers when the progress is incomplete.
Triggers in specified intervals.