angular.Array.remove.html

<h1>angular.Array.remove</h1>
<div class="angular-array-remove"><h2>Description</h2>
<div class="description"><p>Modifies <code>array</code> by removing an element from it. The element will be looked up using the
<a href="#!angular.Array.indexOf"><code>indexOf</code></a> function on the <code>array</code> and only the first instance of
the element will be removed.</p>

<p>Note: this function is used to augment the <code>Array</code> type in angular expressions. See
<a href="#!angular.Array"><code>angular.Array</code></a> for more info.</p></div>
<h2>Usage</h2>
<div class="usage"><div ng:non-bindable=""><pre class="brush: js; html-script: true;">angular.Array.remove(array, value);</pre>
</div>
<h3>Parameters</h3>
<ul class="parameters"><li><code ng:non-bindable="">array – {Array} – </code>
<p>Array from which an element should be removed.</p></li>
<li><code ng:non-bindable="">value – {*} – </code>
<p>Element to be removed.</p></li>
</ul>
<h3>Returns</h3>
<div class="returns"><code ng:non-bindable="">{*}</code>
– <p>The removed element.</p></div>
</div>
<h2>Example</h2>
<div class="example"><doc:example>
<pre class="doc-source">
  &lt;ul ng:init="tasks=['Learn Angular', 'Read Documentation',
                      'Check out demos', 'Build cool applications']"&gt;
    &lt;li ng:repeat="task in tasks"&gt;
      {{task}} [&lt;a href="" ng:click="tasks.$remove(task)"&gt;X&lt;/a&gt;]
    &lt;/li&gt;
  &lt;/ul&gt;
  &lt;hr/&gt;
  tasks = {{tasks}}
</pre>
<pre class="doc-scenario">
  it('should initialize the task list with for tasks', function() {
    expect(repeater('.doc-example-live ul li', 'task in tasks').count()).toBe(4);
    expect(repeater('.doc-example-live ul li', 'task in tasks').column('task')).
      toEqual(['Learn Angular', 'Read Documentation', 'Check out demos',
               'Build cool applications']);
  });

  it('should initialize the task list with for tasks', function() {
    element('.doc-example-live ul li a:contains("X"):first').click();
    expect(repeater('.doc-example-live ul li', 'task in tasks').count()).toBe(3);

    element('.doc-example-live ul li a:contains("X"):last').click();
    expect(repeater('.doc-example-live ul li', 'task in tasks').count()).toBe(2);

    expect(repeater('.doc-example-live ul li', 'task in tasks').column('task')).
      toEqual(['Read Documentation', 'Check out demos']);
  });
</pre>
</doc:example></div>
</div>