UNPKG

can

Version:

MIT-licensed, client-side, JavaScript framework that makes building rich web applications easy.

869 lines (534 loc) 20.6 kB
<!DOCTYPE html> <!--#################################################################### THIS IS A GENERATED FILE -- ANY CHANGES MADE WILL BE OVERWRITTEN INSTEAD CHANGE: source: [object Object] @property can-util/dom/attr/attr.special ######################################################################## --> <html lang="en"> <head> <meta charset="utf-8"> <title>CanJS - special</title> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"> <link rel="stylesheet" type="text/css" href="../../../static/bundles/bit-docs-site/static.css"> <link rel="shortcut icon" sizes="16x16 24x24 32x32 48x48 64x64" href="/docs/images/canjs_favicon.ico"> <link rel="apple-touch-icon" sizes="57x57" href="../../../../docs/images/canjs_favicon_57x57.png"> <link rel="apple-touch-icon-precomposed" sizes="57x57" href="../../../../docs/images/canjs_favicon_57x57.png"> <link rel="apple-touch-icon" sizes="72x72" href="../../../../docs/images/canjs_favicon_72x72.png"> <link rel="apple-touch-icon" sizes="114x114" href="../../../../docs/images/canjs_favicon_114x114.png"> <link rel="apple-touch-icon" sizes="120x120" href="../../../../docs/images/canjs_favicon_128x128.png"> <link rel="apple-touch-icon" sizes="144x144" href="../../../../docs/images/canjs_favicon_144x144.png"> <link rel="apple-touch-icon" sizes="152x152" href="../../../../docs/images/canjs_favicon_152x152.png"> <meta content="yes" name="apple-mobile-web-app-capable"> <meta name="apple-mobile-web-app-status-bar-style" content="white-translucent"> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-2302003-11', 'auto'); ga('send', 'pageview'); </script> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger"/> <label for="nav-trigger">Menu</label> <div id="everything"> <div id="left" class="column"> <div class="top-left"> <div class="brand"> <div class="logo"> <a href="../../../../index.html" alt="CanJS"></a> <div class="dropdown project-dropdown"> <a href="https://donejs.com/">DoneJS</a> <a href="http://stealjs.com/">StealJS</a> <a href="http://jquerypp.com/">jQuery ++</a> <a href="https://funcunit.com/">FuncUnit</a> <a href="http://documentjs.com/">DocumentJS</a> </div> </div> <div class="version"> <div class="version-number"> 3.0.0 </div> <div class="dropdown version-dropdown"> <a href="https://v2.canjs.com">2.3.27</a> </div> </div> </div> <div class="search-bar"> <p> &nbsp; </p> </div> </div> <div class="bottom-left"> <div class="social-side-container"> <ul class="social-side"> <li> <a class="header-mobile github" href="https://github.com/canjs/canjs" target="_blank"><img class="social-icon-small" src="../../../../docs/images/github.png">Github</a> </li> <li> <a class="header-mobile twitter" href="https://twitter.com/canjs" target="_blank"><img class="social-icon-small" src="../../../../docs/images/twitter.png">Twitter</a> </li> </ul> <ul class="social-side"> <li> <a class="header-mobile" href="https://gitter.im/canjs/canjs" target="_blank">Chat</a> </li> <li> <a class="header-mobile" href="http://forums.donejs.com/c/canjs" target="_blank">Forum</a> </li> </ul> </div> <ul> <li class=" "> <a class="page" href="../../../guides.html" title="Welcome to CanJS! These guides are here to help you develop and improve your relationship with CanJS. After all, picking a JavaScript framework is a commitment. We want CanJS to be the framework you marry. This page helps you know how advance through the different stages of this relationship:"> Guides </a> </li> <li class=" "> <a class="page" href="../../../can-core.html" title="The best, most hardened and generally useful libraries in CanJS."> Core </a> </li> <li class=" "> <a class="page" href="../../../can-ecosystem.html" title="Useful libraries that extend or add important features to the core collection."> Ecosystem </a> </li> <li class=" parent expanded"> <a class="page" href="../../../can-infrastructure.html" title="Utility libraries that power the core and ecosystem collection."> Infrastructure </a> <ul> <li class=" "> <a class="module" href="../../../can-construct.html" title="Provides a way to easily use the power of prototypal inheritance without worrying about hooking up all the particulars yourself. Use can-construct.extend to create an inheritable constructor function of your own."> can-construct </a> </li> <li class=" "> <a class="module" href="../../../can-control.html" title="Create organized, memory-leak free, rapidly performing, stateful controls with declarative event binding. Use Control to create UI controls like tabs, grids, and context menus, and organize them into higher-order business rules with can.route. It can serve as both a traditional view and a traditional controller."> can-control </a> </li> <li class=" "> <a class="module" href="../../../can-event.html" title="Add event functionality into your objects. The canEvent object provides a number of methods for handling events in objects. This functionality is best used by mixing the canEvent object into an object or prototype. However, event listeners can still be used even on objects that don&#x27;t include canEvent. All methods provided by canEvent assume that they are mixed into an object -- this should be the object dispatching the events."> can-event </a> </li> <li class=" "> <a class="module" href="../../../can-event/async/async.html" title="Makes the event system asynchronous. WARNING: This is experimental technology."> can-event/async/async </a> </li> <li class=" "> <a class="module" href="../../../can-event/batch/batch.html" title="Adds task batching abilities to event dispatching."> can-event/batch/batch </a> </li> <li class=" "> <a class="module" href="../../../can-observation.html" title="Provides a mechanism to notify when an observable has been read and a way to observe those reads called within a given function."> can-observation </a> </li> <li class=" "> <a class="module" href="../../../can-simple-map.html" title="A performant live-bound map."> can-simple-map </a> </li> <li class=" parent expanded"> <a class="page" href="../../../can-util.html" title="A set of utilities."> can-util </a> <ul> <li class=" parent expanded"> <a class="module" href="../../dom.html" title="A collection of modules that operate on DOM."> can-util/dom </a> <ul> <li class=" "> <a class="module" href="../ajax/ajax.html" title="can-util/dom/ajax/ajax"> ./ajax/ </a> </li> <li class=" parent expanded"> <a class="module" href="attr.html" title="A module that makes it easy to access attributes and properties of elements."> ./attr/ </a> <ul> <li class="current parent expanded"> <a class="property" href="attr.special.html" title="An object used to set up special properties. Each key on attr.special is a name of a property/attribute that has special behaviors when being get, set, or bound to."> special </a> <ul> <li class=" "> <a class="property" href="attr.special.focused.html" title="Signifies if an element, usually an &lt;input&gt; is the focused element on the page."> focused </a> </li> <li class=" "> <a class="property" href="attr.special.values.html" title="A special property that represents the selected values in a &lt;select&gt; element, usually a &lt;select multiple&gt;. The special property is needed because the DOM&#x27;s native value property on a multiple select only gives you one of the selected options&#x27; values."> values </a> </li> </ul> </li> </ul> </li> <li class=" "> <a class="module" href="../child-nodes/child-nodes.html" title="can-util/dom/child-nodes/child-nodes"> ./child-nodes/ </a> </li> <li class=" "> <a class="module" href="../class-name/class-name.html" title="Allows querying and manipulation of classes on HTML elements var className = require(&quot;can-util/dom/class-name/class-name&quot;); var fooDiv = document.createElement(&quot;div&quot;); className.add(fooDiv, &quot;foo&quot;); fooDiv.outerHTML; //-&gt; &#x27;&lt;div class=&quot;foo&quot;&gt;&lt;/div&gt;&#x27;"> ./class-name/ </a> </li> <li class=" "> <a class="module" href="../data/data.html" title="Allows associating data as a key/value pair for a particular DOM Node. var domData = require(&quot;can-util/dom/data/data&quot;);"> ./data/ </a> </li> <li class=" "> <a class="module" href="../dispatch/dispatch.html" title="can-util/dom/dispatch/dispatch"> ./dispatch/ </a> </li> <li class=" "> <a class="module" href="../document/document.html" title="can-util/dom/document/document"> ./document/ </a> </li> <li class=" "> <a class="module" href="../events/events.html" title="Allows you to listen to a domEvent and special domEvents as well as dispatch domEvents. var domEvents = require(&quot;can-util/dom/events/events&quot;);"> ./events/ </a> </li> <li class=" "> <a class="module" href="../frag/frag.html" title="Convert a String, HTMLElement, documentFragment, or contentArray into a documentFragment."> ./frag/ </a> </li> <li class=" "> <a class="module" href="../mutate/mutate.html" title="Mutate an element by appending, inserting, and removing DOM nodes. Use this so that on the server &quot;inserted&quot; will be fired. var mutate = require(&quot;can-util/dom/mutate/mutate&quot;); var el = document.createElement(&quot;div&quot;); el.addEventListener(&quot;inserted&quot;, function(){ console.log(&quot;Inserted was fired!&quot;); }); mutate.appendChild.call(document.body, el);"> ./mutate/ </a> </li> </ul> </li> <li class=" "> <a class="module" href="../../js.html" title="Utilities for manipulating JavaScript data structures."> can-util/js </a> </li> </ul> </li> <li class=" "> <a class="module" href="../../../can-view-callbacks.html" title="Registered callbacks for behaviors"> can-view-callbacks </a> </li> <li class=" "> <a class="module" href="../../../can-view-live.html" title="Setup live-binding between the DOM and a compute manually."> can-view-live </a> </li> <li class=" "> <a class="module" href="../../../can-view-model.html" title="Gets the ViewModel of an element."> can-view-model </a> </li> <li class=" "> <a class="module" href="../../../can-view-nodelist.html" title="Adds nesting of text nodes can.view.nodeLists are used to make sure &quot;directly nested&quot; live-binding sections update content correctly. Consider the following template: &lt;div&gt; {{#if items.length}} Items: {{#items}} &lt;label&gt;&lt;/label&gt; {{/items}} {{/if}} &lt;/div&gt; The {{#if}} and {{#items}} seconds are &quot;directly nested&quot; because they share the same &lt;div&gt; parent element. If {{#items}} changes the DOM by adding more &lt;labels&gt;, {{#if}} needs to know about the &lt;labels&gt; to remove them if {{#if}} is re-rendered. {{#if}} would be re-rendered, for example, if all items were removed."> can-view-nodelist </a> </li> <li class=" "> <a class="module" href="../../../can-view-parser.html" title="Parse HTML and mustache tokens."> can-view-parser </a> </li> <li class=" "> <a class="module" href="../../../can-view-scope.html" title="Create a lookup node for keys."> can-view-scope </a> </li> <li class=" "> <a class="module" href="../../../can-view-target.html" title=""> can-view-target </a> </li> </ul> </li> <li class=" "> <a class="page" href="../../../can-legacy.html" title="Former libraries that we still accept patches for, but are not under active development."> Legacy </a> </li> </ul> </div> </div> <div id="right" class="column"> <div class="top-right"> <div class="top-right-top"> <ul class="top-right-bitovi"> <li class="dropdown"> <a href="http://bitovi.com" class="bitovi icon-bits">Bitovi</a> <ul class="dropdown-menu"> <li><a href="http://bitovi.com">Bitovi.com</a></li> <li><a href="http://bitovi.com/blog/">Blog</a></li> <li><a href="http://bitovi.com/consulting/">Consulting</a></li> <li><a href="http://bitovi.com/training/">Training</a></li> <li><a href="http://bitovi.com/open-source/">Open Source</a></li> </ul> </li> </ul> <div class="brand"> <div class="logo"> <a href="../../../../index.html" alt="CanJS"></a> </div> </div> <ul class="top-right-links"> <li> <a href="https://gitter.im/canjs/canjs">Chat</a> </li> <li> <a href="http://forums.donejs.com/c/canjs">Forum</a> </li> <li> <a class="github-button nav-social" href="https://github.com/canjs/canjs" data-count-href="/canjs/canjs/stargazers" data-count-api="/repos/canjs/canjs#stargazers_count">Star</a> </li> <li> <a href="https://twitter.com/canjs" class="twitter-follow-button nav-social" data-show-count="true" data-show-screen-name="false">Follow @canjs</a><script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script> </li> </ul> </div> <div class="breadcrumb"> <li><a href="../../../../index.html">CanJS</a></li> / <li><a href="../../../can-infrastructure.html">Infrastructure</a></li> / <li><a href="../../../can-util.html">can-util</a></li> / <li><a href="../../dom.html">can-util/dom</a></li> / <li><a href="attr.html">./attr/</a></li> / <li><a href="attr.special.html">special</a></li> <li class="breadcrumb-dropdown">/ <a> On this page</a> <ul class="on-this-page"></ul> </li> <div class="nav-toggle" title="Back to top"></div> </div> </div> <div class="bottom-right"> <article> <section class="title"> <div class="page-type"> <h1>special</h1> <div>property</div> </div> <section class="description"> <p>An object used to set up special properties. Each key on <code>attr.special</code> is a name of a property/attribute that has special behaviors when being get, set, or bound to.</p> </section> </section> <section class="on-this-page-table"> </section> <section class="title-footer"> <ul class="title-links"> <!-- <li><a href="#">docco</a></li> --> <li><a href="//github.com/canjs/can-util/tree/v3.0.11/dom/attr/attr-special.md">source</a></li> <!-- <li><a href="#">download</a></li> --> <!-- <li><a href="#">tests</a></li> --> </ul> </section> <div class="signature"> <h2 class="signature-title"> <code>Object</code> </h2> </div> <section class="body"> <pre><code class="language-js">attr.special.foo = { get: function(){ return this.foo; }, set: function(val){ this.foo = val; }, addEventListener: function(){ // Listen to this property changing some how } }; </code></pre> <p>CanJS comes with a couple of special properties that can be used in bindings:</p> <ul> <li><a href="attr.special.values.html" title="A special property that represents the selected values in a &lt;select&gt; element, usually a &lt;select multiple&gt;. The special property is needed because the DOM's native value property on a multiple select only gives you one of the selected options' values.">values</a></li> <li><a href="attr.special.focused.html" title="Signifies if an element, usually an &lt;input&gt; is the focused element on the page.">focused</a></li> </ul> </section> <script type="text/javascript"> var docObject = {"src":{"path":"node_modules/can-util/dom/attr/attr-special.md"},"description":"\nAn object used to set up special properties. Each key on `attr.special` is a name of a property/attribute that has special behaviors when being get, set, or bound to.\n","types":[{"type":"Object","options":[]}],"title":"special","name":"can-util/dom/attr/attr.special","type":"property","parent":"can-util/dom/attr/attr","pathToRoot":"../../../.."}; </script> </article> <footer><p>CanJS is part of <a href="http://donejs.com" target="_blank">DoneJS</a>. Created and maintained by the core <a href="https://donejs.com/About.html#section=section_Team" target="_blank">DoneJS team</a> and <a href="http://bitovi.com" target="_blank">Bitovi</a>. <strong>Currently 3.0.0.</strong></p></footer> </div> </div> </div> <script> steal = { instantiated: { "bundles/bit-docs-site/static.css!$css" : null } }; </script> <script type='text/javascript' data-main="bit-docs-site/static" src="../../../static/node_modules/steal/steal.production.js"></script> <script async defer src="https://buttons.github.io/buttons.js"></script> </body> </html>