|
| 1 | +# Inline adder |
| 2 | + |
| 3 | +<component-status cx-design="complete" ux="rc"></component-status> |
| 4 | + |
| 5 | +## Usage |
| 6 | + |
| 7 | +### Basic |
| 8 | + |
| 9 | +```html:preview |
| 10 | +<oui-inline-adder> |
| 11 | + <oui-inline-adder-row> |
| 12 | + <oui-inline-adder-field> |
| 13 | + <oui-field label="Field 1"> |
| 14 | + <input type="text" class="oui-input" name="field1" ng-model="field1" required> |
| 15 | + </oui-field> |
| 16 | + </oui-inline-adder-field> |
| 17 | + <oui-inline-adder-field ng-hide="$ctrl.togglerLoading"> |
| 18 | + <oui-field label="Field 2"> |
| 19 | + <input type="text" class="oui-input" name="field2" ng-model="field2" required> |
| 20 | + </oui-field> |
| 21 | + </oui-inline-adder-field> |
| 22 | + </oui-inline-adder-row> |
| 23 | +</oui-inline-adder> |
| 24 | +``` |
| 25 | + |
| 26 | +### Multiple rows |
| 27 | + |
| 28 | +```html:preview |
| 29 | +<oui-inline-adder> |
| 30 | + <oui-inline-adder-row> |
| 31 | + <oui-inline-adder-field> |
| 32 | + <oui-field label="Field 1"> |
| 33 | + <input type="text" class="oui-input" name="field1" ng-model="field1" required> |
| 34 | + </oui-field> |
| 35 | + </oui-inline-adder-field> |
| 36 | + <oui-inline-adder-field> |
| 37 | + <oui-field label="Field 2"> |
| 38 | + <input type="text" class="oui-input" name="field2" ng-model="field2"> |
| 39 | + </oui-field> |
| 40 | + </oui-inline-adder-field> |
| 41 | + </oui-inline-adder-row> |
| 42 | + <oui-inline-adder-row> |
| 43 | + <oui-inline-adder-field> |
| 44 | + <oui-field label="Field 3"> |
| 45 | + <input type="text" class="oui-input" name="field3" ng-model="field3" required> |
| 46 | + </oui-field> |
| 47 | + </oui-inline-adder-field> |
| 48 | + <oui-inline-adder-field> |
| 49 | + <oui-field label="Field 4"> |
| 50 | + <input type="text" class="oui-input" name="field4" ng-model="field4"> |
| 51 | + </oui-field> |
| 52 | + </oui-inline-adder-field> |
| 53 | + </oui-inline-adder-row> |
| 54 | +</oui-inline-adder> |
| 55 | +``` |
| 56 | + |
| 57 | +### Adaptive fields |
| 58 | + |
| 59 | +**Note**: Fields with `adaptive` attribute will adapt their size to their content. |
| 60 | + |
| 61 | +```html:preview |
| 62 | +<oui-inline-adder> |
| 63 | + <oui-inline-adder-row> |
| 64 | + <oui-inline-adder-field> |
| 65 | + <oui-field label="Field 1"> |
| 66 | + <input type="text" class="oui-input" name="field1" ng-model="field1" required> |
| 67 | + </oui-field> |
| 68 | + </oui-inline-adder-field> |
| 69 | + <oui-inline-adder-field adaptive> |
| 70 | + <oui-field label="Field 2" size="m"> |
| 71 | + <label class="oui-select"> |
| 72 | + <select name="field2" ng-model="field2" class="oui-select__input" required> |
| 73 | + <option value="" disabled selected>Select the OS</option> |
| 74 | + <option value="freebsd">FreeBSD</option> |
| 75 | + <option value="linux">Linux</option> |
| 76 | + <option value="osx">OSX</option> |
| 77 | + <option value="windows">Windows</option> |
| 78 | + </select> |
| 79 | + <span class="oui-icon oui-icon-chevron-down" aria-hidden="true"></span> |
| 80 | + </label> |
| 81 | + </oui-field> |
| 82 | + </oui-inline-adder-field> |
| 83 | + <oui-inline-adder-field adaptive> |
| 84 | + <oui-field label="Field 3"> |
| 85 | + <oui-numeric name="field3" model="field3"></oui-numeric> |
| 86 | + </oui-field> |
| 87 | + </oui-inline-adder-field> |
| 88 | + </oui-inline-adder-row> |
| 89 | +</oui-inline-adder> |
| 90 | +``` |
| 91 | + |
| 92 | +### Events |
| 93 | + |
| 94 | +#### `on-add` |
| 95 | + |
| 96 | +**Note**: If you want to access the form inside `on-add` callback, you need to use the `form` variable as below. |
| 97 | + |
| 98 | +```html:preview |
| 99 | +<oui-inline-adder on-add="$ctrl.onAdd(form)"> |
| 100 | + <oui-inline-adder-row> |
| 101 | + <oui-inline-adder-field> |
| 102 | + <oui-field label="Field 1"> |
| 103 | + <input type="text" class="oui-input" name="field1" ng-model="field1" required> |
| 104 | + </oui-field> |
| 105 | + </oui-inline-adder-field> |
| 106 | + </oui-inline-adder-row> |
| 107 | +</oui-inline-adder> |
| 108 | +<div class="oui-doc-preview-only"> |
| 109 | + <p>On Add</p> |
| 110 | + <pre class="oui-doc-code oui-doc-code_json">{{$ctrl.addedForm | json}}</pre> |
| 111 | +</div> |
| 112 | +``` |
| 113 | + |
| 114 | +#### `on-remove` |
| 115 | + |
| 116 | +**Note**: If you want to access the form inside `on-remove` callback, you need to use the `form` variable as below. |
| 117 | + |
| 118 | +```html:preview |
| 119 | +<oui-inline-adder on-remove="$ctrl.onRemove(form)"> |
| 120 | + <oui-inline-adder-row> |
| 121 | + <oui-inline-adder-field> |
| 122 | + <oui-field label="Field 1"> |
| 123 | + <input type="text" class="oui-input" name="field1" ng-model="field1" required> |
| 124 | + </oui-field> |
| 125 | + </oui-inline-adder-field> |
| 126 | + </oui-inline-adder-row> |
| 127 | +</oui-inline-adder> |
| 128 | +<div class="oui-doc-preview-only"> |
| 129 | + <p>On Remove</p> |
| 130 | + <pre class="oui-doc-code oui-doc-code_json">{{$ctrl.removedForm | json}}</pre> |
| 131 | +</div> |
| 132 | +``` |
| 133 | + |
| 134 | +#### `on-change` |
| 135 | + |
| 136 | +**Note**: If you want to access the forms array inside `on-change` callback, you need to use the `forms` variable as below. |
| 137 | + |
| 138 | +```html:preview |
| 139 | +<oui-inline-adder on-change="$ctrl.onChange(forms)"> |
| 140 | + <oui-inline-adder-row> |
| 141 | + <oui-inline-adder-field> |
| 142 | + <oui-field label="Field 1"> |
| 143 | + <input type="text" class="oui-input" name="field1" ng-model="field1" required> |
| 144 | + </oui-field> |
| 145 | + </oui-inline-adder-field> |
| 146 | + </oui-inline-adder-row> |
| 147 | +</oui-inline-adder> |
| 148 | +<div class="oui-doc-preview-only"> |
| 149 | + <p>On Change</p> |
| 150 | + <pre class="oui-doc-code oui-doc-code_json">{{$ctrl.changedForms | json}}</pre> |
| 151 | +</div> |
| 152 | +``` |
| 153 | + |
| 154 | +## API |
| 155 | + |
| 156 | +### oui-inline-adder |
| 157 | + |
| 158 | +| Attribute | Type | Binding | One-time binding | Values | Default | Description |
| 159 | +| ---- | ---- | ---- | ---- | ---- | ---- | ---- |
| 160 | +| `on-add` | function | & | no | n/a | n/a | handler triggered when a row is added |
| 161 | +| `on-remove` | function | & | no | n/a | n/a | handler triggered when a row is removed |
| 162 | +| `on-change` | function | & | no | n/a | n/a | handler triggered when rows have changed |
| 163 | + |
| 164 | +### oui-inline-adder-field |
| 165 | + |
| 166 | +| Attribute | Type | Binding | One-time binding | Values | Default | Description |
| 167 | +| ---- | ---- | ---- | ---- | ---- | ---- | ---- |
| 168 | +| `adaptive` | boolean | <? | yes | `true`, `false` | `false` | adaptive field flag |
0 commit comments