Skip to main content

An Overview On Ionic Action Sheet In Angular(ion-action-sheet)

Ionic Action Sheet is a dialog that contains a collection of actionable buttons that display over the application. Here we are going to understand Ionic Action Sheet implementation in Angular.

ActionSheetController And ActionSheetOptions:

The main building blogs for developing Ionic Action Sheet can be like
  • ActionSheetController
  • ActionSheetOptions
ActionSheetController is imported from the package '@ionic/angular'. ActionSheetController is injectable controller into our any of the ionic angular component through constructor injection. An ActinSheetController can create an n-number of action sheets within the components. ActionSheetController bundled with three main methods like
  • create
  • dismiss
  • getTop
create method helps to instantiate or build the Ionic Action Sheet by taking ActionSheetOptions as input configuration.
Ionic Angular create(action sheet create method) syntax:
create(opts?: Opts): Promise<Overlay>;
dismiss method helps to destroy the action sheet, it takes 'data'(of type any) and 'id'(id of the action sheet as an input parameter) and returns boolean of value promise. On invoking dismiss without passing an 'id'(action sheet id) then the topmost opened action sheet gets closed. If we pass 'id' property that identifies a specific action sheet and closes it.
Ionic Angular dismiss(action sheet dismiss method) syntax:
dismiss(data?: any, role?: string, id?: string): Promise<boolean>;
getTop method helps to return the top-level action sheet overlay on subscribing to this promise. In general words, it returns DOM information of the top-level action sheet.
Ionic Angular getTop(action sheet getTop method) syntax:
getTop(): Promise<Overlay>;
ActionSheetOptions are configurable options to build up the ionic action sheet. ActionSheetOptions included in the package of '@ionic/core'.
action-sheet-interface.d.ts:(ActionSheetOptions Interface Type)
export interface ActionSheetOptions {
    header?: string;
    subHeader?: string;
    cssClass?: string | string[];
    buttons: (ActionSheetButton | string)[];
    backdropDismiss?: boolean;
    translucent?: boolean;
    animated?: boolean;
    mode?: Mode;
    keyboardClose?: boolean;
    id?: string;
    enterAnimation?: AnimationBuilder;
    leaveAnimation?: AnimationBuilder;
}
  • #L2 at this line 'header' property to define the ionic action sheet header.
  • #L3 at this line 'subHeader' property to define the ionic action sheet subheader.
  • #L4 at this line 'cssClass' property to define the custom CSS class to override the styles of an action sheet.
  • #L5 at this line 'buttons' property to define the collection of an actionable button on the action sheet. It is also one and only mandatory property that need to define on configuring ActionSheetOptions
  • #L6 at this line 'backdropDismiss' property of boolean which defined to close the action sheet on clicking backdrop, by default it was set 'true'
  • #L7 at this line 'translucent' property for semi-transparent display this option is specifically for ios devices.
  • #L8 at this line 'animated' property for enabling animation for the action sheet.
  • #L9 at this line 'mode' property for determining the device to apply the platform-specific style to the action sheet.
  • #L10 at this line 'keyboadCloase' property of boolean value to close the action sheet by keyboard buttons.
  • #L11 at this line 'id' property defined to identify the action sheet.

Create Sample Ionic Application:

Let's create an ionic sample application, to better understand the ionic action sheet controller implementation.
Command To Create Ionic App:

ionic start your_project_name tabs

Command To Start Ionic App:

ionic serve

Create And Present ActionSheetController:

The create method of action sheet controller creates a new instance and the present method is to display that instance.

Let's implement a sample action sheet as follows.
src/app/tab1/tab1.page.ts:
import { Component } from "@angular/core";
import { ActionSheetController } from "@ionic/angular";

@Component({
  selector: "app-tab1",
  templateUrl: "tab1.page.html",
  styleUrls: ["tab1.page.scss"],
})
export class Tab1Page {
  constructor(private actionSheetController: ActionSheetController) {}

  async showMyActionSheet(){
    
    const actionSheet = await this.actionSheetController.create({
      buttons:[]
    });

    await actionSheet.present();
  }
  
}
  • #L2 at this line 'ActionSheetController' is imported from '@ionic/angular' package.
  • #L10 at this line 'ActionSheetController' is injected into the 'Tab1page' component constructor.
  • #L12-L19 at these lines defined a method 'showActionSheet' which contains all logic of creating an instance of an action sheet and presenting it.
  • #L14 at this line action sheet controller the create method invoked to create an instance of the action sheet controller.
  • #L14-L16 at these lines we can observe configuration of action sheet, these configurations are of type 'ActionSheetOptions'. Only buttons property is mandatory for the 'ActionSheetOptions', for now, buttons property assigned with an empty array.
  • #L18 at this line action sheet instance calls the method 'present' that will display or render the action sheet to the UI.
Now let's add the ionic button on clicking it we need to invoke this 'showActionSheet()' method. 
src/app/tab1/tab1.page.html:
<ion-button expand="block" (click)="showMyActionSheet()">Open Action Sheet</ion-button>
Let's run the application and output as shown below.
Now click on the button on the page, we can see a black shaded overlay and no action sheet because till now we haven't configured any action sheet buttons.

header And subHeader Options:

Let's add a header and subHeader ActionSheetOptions as follows.
src/app/tab1/tab1.page.ts:
async showMyActionSheet(){
    
    const actionSheet = await this.actionSheetController.create({
      buttons:[],
      header:"Hello I'm Header",
      subHeader:"I'm SubHeader"
    });

    await actionSheet.present();
  }
  • #L5 at this line header option configured.
  • #L6 at this line subHeader option configured.
Now let's run the application and click on the button and action sheet displays as below.

Configure Action Buttons:

In ActionSheetOptions, button property takes an array of buttons of type 'ActionSheetButtons'. Buttons are the core configuration for the ionic action sheet. Each button has its own responsibilities like confirmation, actions, etc.

ActionSheetButton(Interface Type):
export interface ActionSheetButton {
    text?: string;
    role?: 'cancel' | 'destructive' | 'selected' | string;
    icon?: string;
    cssClass?: string | string[];
    handler?: () => boolean | void | Promise<boolean | void>;
}
  • #L2 at this line 'text' property represents the name for the button.
  • #L3 at this line 'role' property represents button role like 'cancel', 'destructive', 'selected' are default role types for the button.
  • #L4 at this line 'icon' property to display the icon for the button.
  • #L5 at this line 'cssClass' property to add custom CSS classes to modify the button style.
  • #L6 at this line 'handler' is call back function that gets invoked on clicking the button.
Let's configure a few sample buttons below.
src/app/tab1/tab1.page.ts:
const actionSheet = await this.actionSheetController.create({
  buttons:[{
	text:'Click Me1',
	role:'',
	cssClass:'',
	handler:()=>{},
	icon:''
  },{
	text:'Click Me2',
	role:'',
	cssClass:'',
	handler:()=>{},
	icon:''
  }],
  header:"Hello I'm Header"
});
Now run the application and open action sheet and output shows as below.

Cancel Role Of Action Button:

As we know we can assign a role for the action button like 'cancel', 'destructive', 'selected'. The array of buttons in the ActionSheetOptions are displayed from top to bottom of array order, but if we assign the role of the button to 'cancel' then the button will show the bottom of the action sheet buttons. So if a button having a role to 'cancel' no matter of position it was declared in the array, it always gets rendered at the bottom of the action sheet.

Let's add the buttons with cancel role as below
src/app/tab1/tab1.page.ts:
const actionSheet = await this.actionSheetController.create({
  buttons:[{
	text:'Click Me1- I have role',
	role:'cancel',
	cssClass:'',
	handler:()=>{},
	icon:''
  },{
	text:'Click Me2',
	role:'',
	cssClass:'',
	handler:()=>{},
	icon:''
  },
  {
	text:'Click Me3',
	role:'',
	cssClass:'',
	handler:()=>{},
	icon:''
  }],
  header:"Hello I'm Header"
});
Here we can observe for the first button we have given the role 'cancel', on rendering this button will be displayed bottom of the action sheet.

Let's run the application and observe the order of the button below.

Handlers Of Action Button:

The handler is a callback function or anonymous method of a button that is executed on clicking the action button. Here in this function, we can implement the logic for the button, for example, calling API. This handler method returns types like a void, boolean, promise.
src/app/tab1/tab1.page.ts:
const actionSheet = await this.actionSheetController.create({
  buttons:[{
	text:'Click Me',
	role:'',
	cssClass:'',
	handler:()=>{
	  console.log("Hello i'm action button handler");
	},
	icon:''
  }],
  header:"Hello I'm Header"
});
#L7 at this line written console log to test on clicking action button handler method invoking or not.

Now let's run the application and click on the action button and then check the browser console which shows the output as below.
If you observe carefully after clicking on the action button the ionic action sheet gets closed immediately. The reason because if the handler method of button return type either 'void' or 'true' then the action sheet gets closed after execution of the handler method. So if you want to avoid closing the action sheet then we need to return 'false' value as return type.

So let's test the avoiding closing of the action sheet by updating the handler code as below.
src/app/tab1/tab1.page.ts:
const actionSheet = await this.actionSheetController.create({
  buttons:[{
	text:'Click Me',
	role:'',
	cssClass:'',
	handler:()=>{
	  return false;
	},
	icon:''
  }],
  header:"Hello I'm Header"
});
#L7 at this line we returning 'false' as an output of the handler to test avoiding closing of action sheet.

Now run the application and click on the action button we can observe that the action sheet will not close now.

backdropDismiss Property:

By default on clicking backdrop overlay, the action sheet gets closed. So to avoid closing of action sheet on clicking backdrop can be achieved by setting backdropDismiss property to 'false'.
src/app/tab1/tab1.page.ts:
const actionSheet = await this.actionSheetController.create({
  buttons:[{
	text:'Click Me',
	role:'',
	cssClass:'',
	handler:()=>{
	},
	icon:''
  }],
  backdropDismiss:false,
  header:"Hello I'm Header"
});
#L10 at this line 'backdropDismiss' property set to false to avoid closing of action sheet on clicking backdrop overlay.

onWillDismiss And on DidDismiss methods:

onWillDismiss and onDidDismiss methods of action sheet controller are callback methods of type promise. 

onWillDismiss method will get invoked before the closing of an action sheet.

onDidDismiss method will get invoke immediately after the closing of an action sheet.

Let's test onWillDismiss and on DidDismiss method by implementing them as below
src/app/tab1/tab1.page.ts:
async showMyActionSheet(){
    
    const actionSheet = await this.actionSheetController.create({
      buttons:[{
        text:'Click Me',
        role:'cancel',
        cssClass:'',
        handler:()=>{
          console.log("handler executed")
        },
        icon:''
      }],
      header:"Hello I'm Header"
    });

    await actionSheet.present();

    actionSheet.onWillDismiss().then((value) => {
      console.log("on will dismiss : -");
      console.log(value);
      debugger;
    });

    actionSheet.onDidDismiss().then((value) => {
      console.log("on did dismiss : -");
      console.log(value)
      debugger;
    })
  }
  • #L18-L22 at these lines registered the onWillDismiss method which gets executed before the closing of the ionic action sheet.
  • #L24-28 at these lines registered the onDidDismiss method which gets executed after-action sheet closed.
Now let's run the application and click on backdrop overlay to close action sheet then output shows below.
now click continue on above debugger then onDidDismiss method gets invoked and output shows below.

Wrapping Up:

Hopefully, I think this article delivered some useful information about the ionic action sheet in angular. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

  1. Hi, first thanks for this tutorial. I have ion-card with action sheet menu and when I click, using mobile, on back button return to previous page and the menu still opened. Do you know how to enable to close menu when click on back button?

    ReplyDelete
    Replies
    1. Hi,
      Try to use backbutton event from platform library, inject the libraray into constructor
      import { Platform } from 'ionic-angular'; //import platform

      constructor(private platform:Platform)

      this.platform.registerBackButtonAction(() => {
      this.actionSheet.dismiss() // write dismiss method of action sheet
      });

      i hope this will resolve your issue
      Thanks

      Delete

Post a Comment

Popular posts from this blog

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route. An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaul

GraphQL API Integration In Asp.Net Core Application

Introduction: GraphQL is a query language for your API and a server-side runtime for executing queries by using a type system you define for your data. GraphQL can be integrated into any framework like ASP.NET, Java, NestJs, etc and it isn't tied to any specific database or storage engine and is instead backed by your existing code and data. How GraphQL API Different From Rest API: GraphQL exposes a single end-point or route for the entire application, regardless of its responses or actions. HTTP-POST is the only Http verb recommended by the GraphQL. The client applications (consumers of API) can give instructions to GraphQL API about what type of properties to be returned in the response. Building Blocks Of GraphQL API: The main building blocks of GraphQL API is Schemas and Types.  A 'Schema' in GrpahQL API describes the functionality available to the clients connect to API. Schema mostly consists of GraphQL Object Types, Queries, Mutations, etc. T

ASP.NET Core Web API Versioning

Introduction: An iteration and evolutionary changes of an ASP.NET Core Web API is handled by Versioning. Versioning of an API gives confidence to the clients which consumes API for a long time. Any changes or development of an API will be accessible using the new version and it won't cause issues to the clients consuming the old version of API. When To Use Versioning: Any API response changes. Developing an API by implementing testing levels like 'Alpha', 'Beta', and 'RC' versions before releasing Production. Deprecating an API which means API going to be removed or upgraded by a version within a short period. Versioning Types: Query String Versioning Url Path Versioning Media Type Versioning API Version Nuget: To Configure versioning to AspNet Core Web API Microsoft provided a library(Microsoft.AspNetCore.Mvc.Versioning). So to use the versioning library please install NuGet below.              Install-Package Microsoft.A

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload: The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client.  Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file.  Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk.  If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application. Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.   Check the link to use the Visual Studio Code for .NET Core Application . IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files f

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items. The main building block of ion-picker as follows: PickerController PickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker. Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger&quo

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library  jQuery Validate . In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples. Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio. Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as bel

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

Blazor Server CRUD Operations

Introduction: Blazor Server is a web framework to develop server-side single-page applications. Blazor is made up of components with the combinations on C#, Html, CSS.  Blazor Server is production-ready from the .Net Core 3.0.  Blazor Server Working Mechanism: Blazor Server is a very light-weight web development framework.  In Blazor Server, not all code gets downloaded to the client browsers. Blazor Server made of components these components can be a block of code or page with respective navigation.  Blazor server application communicates with the server with a SignalR background connection which is inbuilt functionality. Application click,  form submission, change events, application page navigation every operation is carried out by the SignalR connection by communicating with the server.  Blazor updates the Html DOM very gently on every data update without any overhead. Blazor Server application maintains a nice intelligent tree structure to update the required inform

NestJS API CRUD Operations With MongoDB

Introduction: NestJS is a framework used to develop server-side applications. NestJS built on top of Node.js frameworks like Express. It is a combination of Progressive Javascript, Object-Oriented Programming, Functional Programming, and Functional Reactive Programming. Nest CLI Installation: Using Nest CLI we are able to generate the NestJS starter project with the default template. To install Nest CLI globally over our system open command prompt and run the command               npm i -g @nestjs/cli Now create a sample project by using Nest CLI command              nest new your_project_name package.json: Now open the package.json file from the sample application created, you can observe few properties like "scripts", "dependencies", and "devDependencies". "dependencies" contains all plugins to be installed and used them to run the application. "devDependencies" contain all plugins to be installed and used them

Blazor WebAssembly Dynamic Form Validation

Introduction: In Blazor WebAssembly(client-side framework) form validation can be done with Data Annotations. Using Data Annotations we can validate form either by default validation attributes or by creating custom validation attributes. Using this Data Annotation attribute we can dynamically add or remove validation on a specific field in a form. Create Blazor WebAssembly Project: To create a Blazor WebAssembly template project need to install the latest version of VisualStudio 2019 for rich intelligence support or we can use VisualStudio code but less intelligence support from the editor.  Click here to know about Blazor WebAssembly template creation. Blazor WebAssembly is in preview mode, not yet ready for production. Create Razor Component: After creating a sample project using the Blazor WebAssembly template, in "Pages" folder add new Razor Component , name it as "UserForm.razor" Add Route: In Blazor routing can be configured using @