{"_id":"56d91c5707ae190b00004478","__v":1,"category":{"_id":"56d91c5507ae190b00004468","project":"5515ba4981faf83900d2b10c","version":"56d91c5507ae190b00004460","__v":1,"pages":["56d91c5707ae190b00004477","56d91c5707ae190b00004478"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-03-28T05:10:32.768Z","from_sync":false,"order":4,"slug":"internal-api","title":"Internal API"},"user":"54e3723b8ef7552300409bf4","project":"5515ba4981faf83900d2b10c","version":{"_id":"56d91c5507ae190b00004460","__v":1,"project":"5515ba4981faf83900d2b10c","createdAt":"2016-03-04T05:25:41.052Z","releaseDate":"2016-03-04T05:25:41.052Z","categories":["56d91c5507ae190b00004464","56d91c5507ae190b00004465","56d91c5507ae190b00004466","56d91c5507ae190b00004467","56d91c5507ae190b00004468"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"8.0.0","version":"8.0.0"},"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-03-28T05:18:39.517Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":34,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Misses features outside of formly-form\",\n  \"body\": \"Most things you specify as options to configure a field are used by this directive, however, some properties about the field (like `watchers` for example) will simply be ignored. Most of the time you should use the `formly-form` directive instead.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Attributes\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute Name\",\n    \"h-1\": \"Scope Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"options\",\n    \"1-0\": \"model\",\n    \"3-0\": \"formId\",\n    \"4-0\": \"index\",\n    \"5-0\": \"fields\",\n    \"6-0\": \"formState\",\n    \"2-0\": \"form\",\n    \"0-1\": \"`=` binding (required)\",\n    \"1-1\": \"`=` binding (required)\",\n    \"2-1\": \"`=` binding (optional)\",\n    \"3-1\": \"`=` binding (optional)\",\n    \"4-1\": \"`=` binding (optional)\",\n    \"5-1\": \"`=` binding (optional)\",\n    \"6-1\": \"`=` binding (optional)\",\n    \"0-2\": \"The field config. Must have a `type` OR `template` OR `templateUrl`. Everything else is optional, but it is limited to specific properties. Any extra options will result in an error (because angular-formly loves you).\",\n    \"1-2\": \"The model for the field to represent. Most fields will use `ng-model=\\\"model[options.key]\\\"`\",\n    \"2-2\": \"The `NgFormController` that will be used to get and set the `formControl` for the field.\",\n    \"3-2\": \"The id of the form, used to generate the id for the field which is used in the `name` (for the `formControl`) and the `id` of the field (useful for a `label`'s `for` attribute)\",\n    \"5-2\": \"The other fields. As convenience if needed.\",\n    \"4-2\": \"The index of the field, used if `key` is not defined on the field.\",\n    \"6-2\": \"The `formly-form.options.formState` property. This is how fields can communicate with one another without polluting the model.\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<hr />\\n<a href=\\\"https://app.codesponsor.io/link/PKGFLnhDiFvsUA5P4kAXfiPs/formly-js/angular-formly\\\" rel=\\\"nofollow\\\"><img src=\\\"https://app.codesponsor.io/embed/PKGFLnhDiFvsUA5P4kAXfiPs/formly-js/angular-formly.svg\\\" style=\\\"width: 888px; height: 68px;\\\" alt=\\\"Sponsor\\\" /></a>\\n\"\n}\n[/block]","excerpt":"directive","slug":"formly-field","type":"basic","title":"formly-field"}

Guides

Community

Template Libraries

API

Internal API

formly-field

directive
[block:callout] { "type": "danger", "title": "Misses features outside of formly-form", "body": "Most things you specify as options to configure a field are used by this directive, however, some properties about the field (like `watchers` for example) will simply be ignored. Most of the time you should use the `formly-form` directive instead." } [/block] [block:api-header] { "type": "basic", "title": "Attributes" } [/block] [block:parameters] { "data": { "h-0": "Attribute Name", "h-1": "Scope Type", "h-2": "Description", "0-0": "options", "1-0": "model", "3-0": "formId", "4-0": "index", "5-0": "fields", "6-0": "formState", "2-0": "form", "0-1": "`=` binding (required)", "1-1": "`=` binding (required)", "2-1": "`=` binding (optional)", "3-1": "`=` binding (optional)", "4-1": "`=` binding (optional)", "5-1": "`=` binding (optional)", "6-1": "`=` binding (optional)", "0-2": "The field config. Must have a `type` OR `template` OR `templateUrl`. Everything else is optional, but it is limited to specific properties. Any extra options will result in an error (because angular-formly loves you).", "1-2": "The model for the field to represent. Most fields will use `ng-model=\"model[options.key]\"`", "2-2": "The `NgFormController` that will be used to get and set the `formControl` for the field.", "3-2": "The id of the form, used to generate the id for the field which is used in the `name` (for the `formControl`) and the `id` of the field (useful for a `label`'s `for` attribute)", "5-2": "The other fields. As convenience if needed.", "4-2": "The index of the field, used if `key` is not defined on the field.", "6-2": "The `formly-form.options.formState` property. This is how fields can communicate with one another without polluting the model." }, "cols": 3, "rows": 7 } [/block] [block:html] { "html": "<hr />\n<a href=\"https://app.codesponsor.io/link/PKGFLnhDiFvsUA5P4kAXfiPs/formly-js/angular-formly\" rel=\"nofollow\"><img src=\"https://app.codesponsor.io/embed/PKGFLnhDiFvsUA5P4kAXfiPs/formly-js/angular-formly.svg\" style=\"width: 888px; height: 68px;\" alt=\"Sponsor\" /></a>\n" } [/block]