Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
gwagroves committed May 3, 2017
1 parent e52cb0c commit 6abd5ef
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,51 @@ Modules with `?` are considered _optional_.
Modules with `+` are considered _multiple_ (i.e. one or more occurances).
Modules with `*` are considered both _optional and multiple_ (i.e. zero, one or more occurances).

### Inner DOM wrappers

A module might often contain an _inner wrapper_ that in turn contains the contained modules.

You can document this by adding it to the `dom` setting.

```yaml
dom: div>div.wrapper
class: ui-block
```

defines:

```markup
<div class="ui-block">
<div class="wrapper">
<!-- modules go here -->
</div>
</div>
```

You can also define the wrapper as its own module, e.g. `WRAPPER`, and then use that:

```yaml
name: WRAPPER
dom: div
class: ui-wrapper
```

```yaml
name: BLOCK
dom: div>WRAPPER
class: ui-block
```

defines:

```markup
<div class="ui-block">
<div class="ui-wrapper">
<!-- modules go here -->
</div>
</div>
```

## The "moduledoc" task

### Overview
Expand Down

0 comments on commit 6abd5ef

Please sign in to comment.