firka/flutter
firka/flutter
5
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: fix markdown in various files, update the README mildly

Browse Source 
Review URL: https://codereview.chromium.org/678693003
This commit is contained in:
Hixie 2014-10-24 14:14:34 -07:00
parent 44d30c6fa6
commit 6d1044e8a6
1 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
engine/src/flutter/README.md
View File

@ -17,7 +17,7 @@ theme layer that gives each widget a concrete visual and interactive design.
Elements Elements
-------- --------
The Sky engine contains a handful of primitive elements and the tools with which The Sky engine contains [a handful of primitive elements](specs/markup.md) and the tools with which
to create custom elements. The following elements are built into the engine: to create custom elements. The following elements are built into the engine:
- ``script``: Executes script - ``script``: Executes script
@ -27,9 +27,10 @@ to create custom elements. The following elements are built into the engine:
- ``template``: Captures descendants for use as a template - ``template``: Captures descendants for use as a template
- ``content``: Visually projects descendents of the shadow host - ``content``: Visually projects descendents of the shadow host
- ``shadow``: Visually projects older shadow roots of the shadow host - ``shadow``: Visually projects older shadow roots of the shadow host
- ``image``: Displays an image - ``img``: Displays an image
- ``a``: Links to another Mojo application - ``a``: Links to another Mojo application
- ``title``: Briefly describes the current application state to the user - ``title``: Briefly describes the current application state to the user
- ``t``: Preserve whitespace (by default, whitespace nodes are dropped)
### Additional Elements ### ### Additional Elements ###
@ -64,10 +65,19 @@ For example, the ``AnnualReport`` constructor uses the ``BalanceSheet`` class
exported by that module. exported by that module.
```html ```html
<import href=”/sky/framework” /> SKY MODULE
<import href=”/another/module.sky” as=”foo” /> <import src=”/sky/framework” />
<import src=”/another/module.sky” as=”foo” />
<sky-element name=”my-element”> <sky-element name=”my-element”>
[ ... custom element definition ... ] class extends SkyElement {
constructor () {
this.addEventListener('click', (event) => this.updateTime());
this.createShadowTree().appendChild('Click to show the time');
}
updateTime() {
this.shadowTree.firstChild.replaceWith(new Date());
}
}
</sky-element> </sky-element>
<script> <script>
class AnnualReport { class AnnualReport {
@ -114,9 +124,10 @@ As an example, the following is a sketch of a module that wraps Mojo's
``network_service`` in a simpler functional interface: ``network_service`` in a simpler functional interface:
```html ```html
<import href=”mojo://shell” as=”shell” /> SKY MODULE
<import href="/mojo/network/network_service.mojom.sky" as="net" /> <import src=”mojo://shell” as=”shell” />
<import href="/mojo/network/url_loader.mojom.sky" as="loader" /> <import src="/mojo/network/network_service.mojom.sky" as="net" />
<import src="/mojo/network/url_loader.mojom.sky" as="loader" />
<script> <script>
module.exports = function fetch(url) { module.exports = function fetch(url) {
return new Promise(function(resolve, reject) { return new Promise(function(resolve, reject) {
@ -150,6 +161,6 @@ and the specification are in flux, but hopefully they'll converge over time.
Contributing Contributing
------------ ------------
Instructions for building and testing Sky are contained in [HACKING.md]. For Instructions for building and testing Sky are contained in [HACKING.md](HACKING.md). For
coordination, we use the ``#mojo`` IRC channel on coordination, we use the ``#mojo`` IRC channel on
[Freenode](https://freenode.net/). [Freenode](https://freenode.net/).