5 lines
32 KiB
JSON
5 lines
32 KiB
JSON
{
|
|
"id": "api/forms/RadioControlValueAccessor",
|
|
"title": "RadioControlValueAccessor",
|
|
"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/forms\", \"name\": \"@angular/forms\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/forms/RadioControlValueAccessor\", \"name\": \"RadioControlValueAccessor\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/forms\">@angular/forms</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/forms/src/directives/radio_control_value_accessor.ts?message=docs(forms)%3A%20describe%20your%20change...#L86-L229\" 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/forms/src/directives/radio_control_value_accessor.ts#L86-L229\" 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=\"radiocontrolvalueaccessor\">RadioControlValueAccessor<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/forms/RadioControlValueAccessor#radiocontrolvalueaccessor\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label directive\">directive</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>The <code><a href=\"api/forms/ControlValueAccessor\" class=\"code-anchor\">ControlValueAccessor</a></code> for writing radio control values and listening to radio control\nchanges. The value accessor is used by the <code><a href=\"api/forms/FormControlDirective\" class=\"code-anchor\">FormControlDirective</a></code>, <code><a href=\"api/forms/FormControlName\" class=\"code-anchor\">FormControlName</a></code>, and\n<code><a href=\"api/forms/NgModel\" class=\"code-anchor\">NgModel</a></code> directives.</p>\n\n \n </section>\n \n \n \n \n\n <h2 id=\"ngmodules\">NgModules<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/forms/RadioControlValueAccessor#ngmodules\"><i class=\"material-icons\">link</i></a></h2>\n<ul class=\"ngmodule-list\">\n\n <li>\n <a href=\"api/forms/ReactiveFormsModule\">\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box\">ReactiveFormsModule</code-example>\n </a>\n </li>\n \n <li>\n <a href=\"api/forms/FormsModule\">\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box\">FormsModule</code-example>\n </a>\n </li>\n \n</ul>\n\n\n \n<section class=\"selector-list\">\n <h2 id=\"selectors\">Selectors<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/forms/RadioControlValueAccessor#selectors\"><i class=\"material-icons\">link</i></a></h2>\n \n <ul>\n <li><code>input[type=radio][<a href=\"api/forms/FormControlName\" class=\"code-anchor\">formControlName</a>]</code></li>\n \n <li><code>input[type=radio][formControl]</code></li>\n \n <li><code>input[type=radio][<a href=\"api/forms/NgModel\" class=\"code-anchor\">ngModel</a>]</code></li>\n \n </ul>\n \n</section>\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/forms/RadioControlValueAccessor#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=\"name\"></a>\n <code class=\"\"><span class=\"property-binding\">@<a href=\"api/core/Input\" class=\"code-anchor\">Input</a>()</span><br><span class=\"member-name\">name</span>: string</code>\n </td>\n <td>\n \n <p>Tracks the name of the radio input element.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"formControlName\"></a>\n <code class=\"\"><span class=\"property-binding\">@<a href=\"api/core/Input\" class=\"code-anchor\">Input</a>()</span><br><span class=\"member-name\"><a href=\"api/forms/FormControlName\" class=\"code-anchor\">formControlName</a></span>: string</code>\n </td>\n <td>\n \n <p>Tracks the name of the <code><a href=\"api/forms/FormControl\" class=\"code-anchor\">FormControl</a></code> bound to the directive. The name corresponds\nto a key in the parent <code><a href=\"api/forms/FormGroup\" class=\"code-anchor\">FormGroup</a></code> or <code><a href=\"api/forms/FormArray\" class=\"code-anchor\">FormArray</a></code>.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"value\"></a>\n <code class=\"\"><span class=\"property-binding\">@<a href=\"api/core/Input\" class=\"code-anchor\">Input</a>()</span><br><span class=\"member-name\">value</span>: any</code>\n </td>\n <td>\n \n <p>Tracks the value of the radio input element</p>\n\n \n </td>\n </tr>\n \n </tbody>\n </table>\n</section>\n\n\n\n \n\n\n \n <section class=\"description\">\n <h2 id=\"description\">Description<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/forms/RadioControlValueAccessor#description\"><i class=\"material-icons\">link</i></a></h2>\n \n <h3 id=\"using-radio-buttons-with-reactive-form-directives\">Using radio buttons with reactive form directives<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/forms/RadioControlValueAccessor#using-radio-buttons-with-reactive-form-directives\"><i class=\"material-icons\">link</i></a></h3>\n<p>The follow example shows how to use radio buttons in a reactive form. When using radio buttons in\na reactive form, radio buttons in the same group should have the same <code><a href=\"api/forms/FormControlName\" class=\"code-anchor\">formControlName</a></code>.\nProviding a <code>name</code> attribute is optional.</p>\n<code-example path=\"forms/ts/reactiveRadioButtons/reactive_radio_button_example.ts\" region=\"Reactive\">\nimport {<a href=\"api/core/Component\" class=\"code-anchor\">Component</a>} from '@angular/core';\nimport {<a href=\"api/forms/FormControl\" class=\"code-anchor\">FormControl</a>, <a href=\"api/forms/FormGroup\" class=\"code-anchor\">FormGroup</a>} from '@angular/forms';\n\n@<a href=\"api/core/Component\" class=\"code-anchor\">Component</a>({\n selector: 'example-app',\n template: `\n <form [formGroup]=\"form\">\n <input type=\"radio\" <a href=\"api/forms/FormControlName\" class=\"code-anchor\">formControlName</a>=\"food\" value=\"beef\" > Beef\n <input type=\"radio\" <a href=\"api/forms/FormControlName\" class=\"code-anchor\">formControlName</a>=\"food\" value=\"lamb\"> Lamb\n <input type=\"radio\" <a href=\"api/forms/FormControlName\" class=\"code-anchor\">formControlName</a>=\"food\" value=\"fish\"> Fish\n </form>\n\n <p><a href=\"api/forms/Form\" class=\"code-anchor\">Form</a> value: {{ form.value | <a href=\"api/common/JsonPipe\" class=\"code-anchor\">json</a> }}</p> <!-- {food: 'lamb' } -->\n `,\n})\nexport class ReactiveRadioButtonComp {\n form = new <a href=\"api/forms/FormGroup\" class=\"code-anchor\">FormGroup</a>({\n food: new <a href=\"api/forms/FormControl\" class=\"code-anchor\">FormControl</a>('lamb'),\n });\n}\n\n</code-example>\n\n </section>\n \n\n \n\n \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/forms/RadioControlValueAccessor#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"fireUncheck\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"fireuncheck\">\n fireUncheck()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/forms/RadioControlValueAccessor#fireuncheck\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/forms/src/directives/radio_control_value_accessor.ts?message=docs(forms)%3A%20describe%20your%20change...#L196-L204\" 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/forms/src/directives/radio_control_value_accessor.ts#L196-L204\" 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>Sets the \"value\" on the radio input element and unchecks it.</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\">fireUncheck</span>(value: any): void</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>value</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns\">Returns</h6>\n <p><code>void</code></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 </div>\n</article>\n\n<!-- links to this doc:\n - api/core/OnDestroy\n - api/core/OnInit\n - api/forms\n - api/forms/ControlValueAccessor\n - api/forms/FormControlName\n - api/forms/FormsModule\n - api/forms/NgModel\n - api/forms/ReactiveFormsModule\n-->\n<!-- links from this doc:\n - /api\n - api/common/JsonPipe\n - api/core/Component\n - api/core/Input\n - api/forms\n - api/forms/ControlValueAccessor\n - api/forms/Form\n - api/forms/FormArray\n - api/forms/FormControl\n - api/forms/FormControlDirective\n - api/forms/FormControlName\n - api/forms/FormGroup\n - api/forms/FormsModule\n - api/forms/NgModel\n - api/forms/RadioControlValueAccessor#description\n - api/forms/RadioControlValueAccessor#fireuncheck\n - api/forms/RadioControlValueAccessor#methods\n - api/forms/RadioControlValueAccessor#ngmodules\n - api/forms/RadioControlValueAccessor#properties\n - api/forms/RadioControlValueAccessor#radiocontrolvalueaccessor\n - api/forms/RadioControlValueAccessor#selectors\n - api/forms/RadioControlValueAccessor#using-radio-buttons-with-reactive-form-directives\n - api/forms/ReactiveFormsModule\n - https://github.com/angular/angular/edit/master/packages/forms/src/directives/radio_control_value_accessor.ts?message=docs(forms)%3A%20describe%20your%20change...#L196-L204\n - https://github.com/angular/angular/edit/master/packages/forms/src/directives/radio_control_value_accessor.ts?message=docs(forms)%3A%20describe%20your%20change...#L86-L229\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/forms/src/directives/radio_control_value_accessor.ts#L196-L204\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/forms/src/directives/radio_control_value_accessor.ts#L86-L229\n-->"
|
|
} |