5 lines
9.7 KiB
JSON
5 lines
9.7 KiB
JSON
{
|
|
"id": "api/platform-browser/HammerGestureConfig",
|
|
"title": "HammerGestureConfig",
|
|
"contents": "\n\n<article>\n <div class=\"breadcrumb-container\">\n <div class=\"breadcrumb\">\n <script type=\"application/ld+json\">\n {\n \"@context\": \"http://schema.org\",\n \"@type\": \"BreadcrumbList\",\n \"itemListElement\": [\n { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://angular.io//api\", \"name\": \"API\" } },\n { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://angular.io/api/platform-browser\", \"name\": \"@angular/platform-browser\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/platform-browser/HammerGestureConfig\", \"name\": \"HammerGestureConfig\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/platform-browser\">@angular/platform-browser</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/platform-browser/src/dom/events/hammer_gestures.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L87-L156\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-browser/src/dom/events/hammer_gestures.ts#L87-L156\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n \n <header class=\"api-header\">\n <h1 id=\"hammergestureconfig\">HammerGestureConfig<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-browser/HammerGestureConfig#hammergestureconfig\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label class\">class</label>\n \n \n \n </header>\n \n <aio-toc class=\"embedded\"></aio-toc>\n\n <div class=\"api-body\">\n \n <section class=\"short-description\">\n <p>An injectable <a href=\"https://hammerjs.github.io/api/#hammermanager\">HammerJS Manager</a>\nfor gesture recognition. Configures specific event recognition.</p>\n\n \n </section>\n \n \n \n <section class=\"class-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nclass <a href=\"api/platform-browser/HammerGestureConfig\" class=\"code-anchor\">HammerGestureConfig</a> {\n <a class=\"code-anchor\" href=\"api/platform-browser/HammerGestureConfig#events\"><span class=\"member-name\">events</span>: string[]</a>\n <a class=\"code-anchor\" href=\"api/platform-browser/HammerGestureConfig#overrides\"><span class=\"member-name\">overrides</span>: {...}</a>\n <a class=\"code-anchor\" href=\"api/platform-browser/HammerGestureConfig#options\"><span class=\"member-name\">options</span>?: {...}</a>\n <a class=\"code-anchor\" href=\"api/platform-browser/HammerGestureConfig#buildHammer\"><span class=\"member-name\">buildHammer</span>(element: HTMLElement): HammerInstance</a>\n}\n</code-example>\n\n \n \n\n</section>\n\n\n \n\n \n \n \n\n\n\n\n\n\n\n\n<section class=\"instance-properties\">\n <h2 id=\"properties\">Properties<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-browser/HammerGestureConfig#properties\"><i class=\"material-icons\">link</i></a></h2>\n <table class=\"is-full-width list-table property-table\">\n <thead>\n <tr>\n <th>Property</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"events\"></a>\n <code class=\"\"><span class=\"member-name\">events</span>: string[]</code>\n </td>\n <td>\n \n <p>A set of supported event names for gestures to be used in Angular.\nAngular supports all built-in recognizers, as listed in\n<a href=\"https://hammerjs.github.io/\">HammerJS documentation</a>.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"overrides\"></a>\n <code class=\"\"><span class=\"member-name\">overrides</span>: {\n [key: string]: Object;\n}</code>\n </td>\n <td>\n \n <p>Maps gesture event names to a set of configuration options\nthat specify overrides to the default values for specific properties.</p>\n\n <p>The key is a supported event name to be configured,\nand the options object contains a set of properties, with override values\nto be applied to the named recognizer event.\nFor example, to disable recognition of the rotate event, specify\n<code>{\"rotate\": {\"enable\": false}}</code>.</p>\n<p>Properties that are not present take the HammerJS default values.\nFor information about which properties are supported for which events,\nand their allowed and default values, see\n<a href=\"https://hammerjs.github.io/\">HammerJS documentation</a>.</p>\n\n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"options\"></a>\n <code class=\"\"><span class=\"member-name\">options</span>?: {\n cssProps?: any;\n domEvents?: boolean;\n enable?: boolean | ((manager: any) => boolean);\n preset?: any[];\n touchAction?: string;\n recognizers?: any[];\n inputClass?: any;\n inputTarget?: EventTarget;\n}</code>\n </td>\n <td>\n \n <p>Properties whose default values can be overridden for a given event.\nDifferent sets of properties apply to different events.\nFor information about which properties are supported for which events,\nand their allowed and default values, see\n<a href=\"https://hammerjs.github.io/\">HammerJS documentation</a>.</p>\n\n \n </td>\n </tr>\n \n </tbody>\n </table>\n</section>\n\n\n\n<section class=\"instance-methods\">\n <h2 id=\"methods\">Methods<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-browser/HammerGestureConfig#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"buildHammer\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"buildhammer\">\n buildHammer()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-browser/HammerGestureConfig#buildhammer\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/platform-browser/src/dom/events/hammer_gestures.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L137-L155\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-browser/src/dom/events/hammer_gestures.ts#L137-L155\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Creates a <a href=\"https://hammerjs.github.io/api/#hammermanager\">HammerJS Manager</a>\nand attaches it to a given HTML element.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">buildHammer</span>(element: HTMLElement): HammerInstance</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>element</code>\n </td>\n <td class=\"param-type\"><code>HTMLElement</code></td>\n <td class=\"param-description\">\n <p>The element that will recognize gestures.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns\">Returns</h6>\n <p><code>HammerInstance</code>: A HammerJS event-manager object.</p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n</section>\n\n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/platform-browser\n - api/platform-browser/HAMMER_GESTURE_CONFIG\n-->\n<!-- links from this doc:\n - /api\n - api/platform-browser\n - api/platform-browser/HammerGestureConfig#buildHammer\n - api/platform-browser/HammerGestureConfig#buildhammer\n - api/platform-browser/HammerGestureConfig#events\n - api/platform-browser/HammerGestureConfig#hammergestureconfig\n - api/platform-browser/HammerGestureConfig#methods\n - api/platform-browser/HammerGestureConfig#options\n - api/platform-browser/HammerGestureConfig#overrides\n - api/platform-browser/HammerGestureConfig#properties\n - https://github.com/angular/angular/edit/master/packages/platform-browser/src/dom/events/hammer_gestures.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L137-L155\n - https://github.com/angular/angular/edit/master/packages/platform-browser/src/dom/events/hammer_gestures.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L87-L156\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-browser/src/dom/events/hammer_gestures.ts#L137-L155\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-browser/src/dom/events/hammer_gestures.ts#L87-L156\n - https://hammerjs.github.io/\n - https://hammerjs.github.io/api/#hammermanager\n-->"
|
|
} |