diff --git a/awx/ui/static/lib/ansible/form-generator.js b/awx/ui/static/lib/ansible/form-generator.js index 74a34265ae..4c5e6bb2cf 100644 --- a/awx/ui/static/lib/ansible/form-generator.js +++ b/awx/ui/static/lib/ansible/form-generator.js @@ -21,10 +21,11 @@ * * | Parameter | Required | Description | * | --------- | -------- | ----------- | - * | mode | Y | 'add', 'edit' or 'modal'. Use add when creating new data - creating a new orgranization, for example. Use edit when modifying existing data. Modal is deprecated. Use the 'id' option to inject a form into a modal dialog. | - * | id | | The ID attribute value of the DOM elment that will receive the generated HTML. If provided, form generator will inject the HTML it genertates into the DOM element identified by the string value provided. Do not preceed the value with '#' | * | html | | String of HTML to be injected. Overrides HTML that would otherwise be generated using the form object. (Not sure if this is actually used anywhere.) | + * | id | | The ID attribute value of the DOM elment that will receive the generated HTML. If provided, form generator will inject the HTML it genertates into the DOM element identified by the string value provided. Do not preceed the value with '#' | + * | mode | Y | 'add', 'edit' or 'modal'. Use add when creating new data - creating a new orgranization, for example. Use edit when modifying existing data. Modal is deprecated. Use the 'id' option to inject a form into a modal dialog. | * | scope | | Reference to $scope object. Will be passed to $compile and associated with any angular directives contained within the generated HTML. | + * | breadCrumbs | | true or false. If false, breadcrumbs will not be inlcluded in the generated HTML. | * * # Generate HTML Only * @@ -40,6 +41,23 @@ * * Call GenerateFrom.reset() to clear user input, remove error messages and return the angular form object back to a pristine state. This is should be called when the user clicks the Reset button. * + * # Form definitions + * + * See forms/*.js for examples. + * + * The form object can have the following attributes: + * + * | Atribute | Description | + * | -------- | ----------- | + * | addTitle | Title to use in breadcrumbs when the form mode is 'add' | + * | editTitle | Title to use in breadcrumbs when the form mode is 'edit' | + * | name | Name to give the form object. Used to create the id and name attribute values in the