carbon-components-angular

<!doctype html> <html class="no-js" lang=""> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <title>carbon-components-angular documentation</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="icon" type="image/x-icon" href="../images/favicon.ico"> <link rel="stylesheet" href="../styles/style.css"> <link rel="stylesheet" href="../styles/dark.css"> </head> <body> <div class="navbar navbar-default navbar-fixed-top d-block d-sm-none"> <a href="../" class="navbar-brand">carbon-components-angular documentation</a> <button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button> </div> <div class="xs-menu menu" id="mobile-menu"> <div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu> </div> <div class="container-fluid main"> <div class="row main"> <div class="hidden-xs menu"> <compodoc-menu mode="normal"></compodoc-menu> </div>  <div class="content interface"> <div class="content-data"> <ol class="breadcrumb"> <li class="breadcrumb-item">Interfaces</li> <li class="breadcrumb-item" > CloseMeta</li> </ol> <ul class="nav nav-tabs" role="tablist"> <li class="nav-item"> <a href="#info" class="nav-link" class="nav-link active" role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a> </li> <li class="nav-item"> <a href="#source" class="nav-link" role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a> </li> </ul> <div class="tab-content"> <div class="tab-pane fade active in" id="info"> <p class="comment"> <h3>File</h3> </p> <p class="comment"> <code>src/dialog/dialog-config.interface.ts</code> </p> <p class="comment"> <h3>Description</h3> </p> <p class="comment"> <p>Interface representing various metadata that can be passed to <code>shouldClose</code> and the <code>close</code> event</p> </p> <section data-compodoc="block-index"> <h3 id="index">Index</h3> <table class="table table-sm table-bordered index-table"> <tbody> <tr> <td class="col-md-4"> <h6><b>Properties</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#reason" > reason </a> </li> <li> <span class="modifier">Optional</span> <a href="#target" > target </a> </li> </ul> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-properties"> <h3 id="inputs">Properties</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="reason"></a> <span class="name "><b>reason</b> <a href="#reason"> <span class="icon ion-ios-link"></span> </a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>reason: <code><a href="../miscellaneous/enumerations.html#CloseReasons" target="_self" >CloseReasons</a></code> </code> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="../miscellaneous/enumerations.html#CloseReasons" target="_self" >CloseReasons</a></code> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="target"></a> <span class="name "><b>target</b> <a href="#target"> <span class="icon ion-ios-link"></span> </a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>target: <code><a href="../miscellaneous/enumerations.html#Target" target="_self" >EventTarget</a></code> </code> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="../miscellaneous/enumerations.html#Target" target="_self" >EventTarget</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Optional</i> </td> </tr> </tbody> </table> </section> </div> <div class="tab-pane fade tab-source-code" id="source"> <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { ElementRef, TemplateRef } from "@angular/core"; /** * An enum of the various reasons a dialog may close. For use with `CloseMeta` and `shouldClose` * * It's expected that `interaction` will be a common closure reason. */ export enum CloseReasons { /** * For when the component is closed by being destroyed */ destroyed, /** * For use in cases where the dialog closes for programmatic reasons other than destruction */ programmatic, /** * interaction reasons will also provide a target for the interaction */ interaction, /** * For use in cases where the dialog closes due to being hidden */ hidden } /** * Interface representing various metadata that can be passed to `shouldClose` and the `close` event */ export interface CloseMeta { reason: CloseReasons; target?: EventTarget; } /** * Data structure for definig properties of a `Dialog` component. **/ export interface DialogConfig { /** * Title for the `Dialog` header. */ title?: string; /** * Body content for the `Dialog`. */ content: string | TemplateRef<any>; /** * Parameter for triggering `Dialog` display. */ trigger?: "click" | "hover" | "mouseenter"; /** * Parameter for triggering the `Dialog` close event. */ closeTrigger?: "mouseout" | "mouseleave"; /** * Callback to control the closing behaviour. return `true` to close, and `false` to prevent closing */ shouldClose?: (meta?: CloseMeta) => boolean; /** * If true the dialog will close when hidden (by scrolling or otherwise going out of the viewport) * If false the dialog will stay open until explicitly closed * When true this closure method can be picked up via `CloseReasons.hidden` */ closeWhenHidden?: boolean; /** * Parameter defining the placement in which the `Dialog` appears. */ placement?: string; /** * Used to set the offset of the `Dialog` relative to the content it * is associated to. */ gap?: number; /** * Reference to the Parent element that links the `Dialog`. */ parentRef?: ElementRef; /** * Set to `true` to open the dialog next to the triggering component */ appendInline?: boolean; /** * Config object passed to the rendered component. (Optional) */ data?: Object; /** * Additional arbitrary properties (mostly for internal/extended component use) */ [propName: string]: any; /** * Classes to add to the dialog container */ wrapperClass?: string; /** * This specifies any vertical and horizontal offset for the position of the dialog */ offset?: { x: number, y: number }; /** * This prevents the dialog from being toggled */ disabled?: boolean; } </code></pre> </div> </div> </div><div class="search-results"> <div class="has-results"> <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1> <ul class="search-results-list"></ul> </div> <div class="no-results"> <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> </div> </div> </div>  </div> </div> <label class="dark-mode-switch"> <input type="checkbox"> <span class="slider"> <svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg"> <path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path> </svg> </span> </label> <script> var COMPODOC_CURRENT_PAGE_DEPTH = 1; var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface'; var COMPODOC_CURRENT_PAGE_URL = 'CloseMeta.html'; var MAX_SEARCH_RESULTS = 15; </script> <script src="../js/libs/custom-elements.min.js"></script> <script src="../js/libs/lit-html.js"></script> <script src="../js/menu-wc.js" defer></script> <script nomodule src="../js/menu-wc_es5.js" defer></script> <script src="../js/libs/bootstrap-native.js"></script> <script src="../js/libs/es6-shim.min.js"></script> <script src="../js/libs/EventDispatcher.js"></script> <script src="../js/libs/promise.min.js"></script> <script src="../js/libs/zepto.min.js"></script> <script src="../js/compodoc.js"></script> <script src="../js/tabs.js"></script> <script src="../js/menu.js"></script> <script src="../js/libs/clipboard.min.js"></script> <script src="../js/libs/prism.js"></script> <script src="../js/sourceCode.js"></script> <script src="../js/search/search.js"></script> <script src="../js/search/lunr.min.js"></script> <script src="../js/search/search-lunr.js"></script> <script src="../js/search/search_index.js"></script> <script src="../js/lazy-load-graphs.js"></script> </body> </html>