-
-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9f2dfcd
commit d5a807c
Showing
1 changed file
with
144 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,157 @@ | ||
# Attributes deep dive | ||
|
||
You’ve just rebuilt 90% of Phlex so you know a thing or two about rendering attributes. | ||
You’ve just rebuilt 90% of Phlex so you know a thing or two about rendering attributes, right? | ||
|
||
In the previous example, we rendered attributes like this: | ||
|
||
```ruby | ||
attributes.each do |key, value| | ||
@buffer << " #{key}=\"#{value}\"" | ||
end | ||
``` | ||
|
||
## Keys | ||
|
||
- Difference between string and symbol keys | ||
If you use symbols for keys, Phlex will replace underscores `_` with dashes `-`. This is because the convention in HTML is to use dashes, while on the Ruby side, dashes are not allowed in symbols. | ||
|
||
If you need to keep an underscore in the attribute name, you can use a string instead: | ||
|
||
## Values | ||
::: code-group | ||
|
||
- Strings | ||
- Arrays | ||
- Sets | ||
- Booleans | ||
- Custom objects | ||
```ruby [component] | ||
h1(data_controller: "hello") { "Hello!" } | ||
h1("data_controller" => "hello") { "Hello!" } | ||
``` | ||
|
||
```html [output] | ||
<h1 foo-bar="hello">👋 Hello World!</h1> | ||
<h1 foo_bar="hello">👋 Hello World!</h1> | ||
``` | ||
|
||
::: | ||
|
||
## Nested attributes | ||
|
||
- Describe how hashes work | ||
You can nest attributes by using a hash as the value. The hash will be flattened with a dash between each level: | ||
|
||
::: code-group | ||
|
||
```ruby [component] | ||
h1(data: { controller: "hello" }) { "Hello!" } | ||
``` | ||
|
||
```html [output] | ||
<h1 data-controller="hello">👋 Hello World!</h1> | ||
``` | ||
|
||
::: | ||
|
||
## Attribute values | ||
|
||
You’ve seen how string values work. Symbols behave the same way. You’ve also seen how to nest attributes with hashes. But Phlex allows a few other types of attribute value. | ||
|
||
### Arrays and sets | ||
|
||
::: code-group | ||
|
||
```ruby [component] | ||
h1(class: ["foo", "bar"]) { "Hello!" } | ||
h1(class: Set["foo", "bar"]) { "Hello!" } | ||
``` | ||
|
||
```html [output] | ||
<h1 class="foo bar">Hello!</h1> | ||
<h1 class="foo bar">Hello!</h1> | ||
``` | ||
|
||
::: | ||
|
||
### Booleans | ||
|
||
Booleans are a special case. If the value is `true`, Phlex will render the attribute without a value. If the value is `false`, Phlex will not render the attribute at all. | ||
|
||
::: code-group | ||
|
||
```ruby [component] | ||
textarea(disabled: true) | ||
textarea(disabled: false) | ||
``` | ||
|
||
```html [output] | ||
<textarea disabled></textarea> <textarea></textarea> | ||
``` | ||
|
||
::: | ||
|
||
::: tip | ||
Some HTML attributes such as `contenteditable` require you to pass `"true"` or `"false"` as a string. These are not technically “boolean” attributes, they're “enumerated” attributes. The distinction is subtle but important. | ||
|
||
::: | ||
|
||
## Special attributes | ||
|
||
- `style` | ||
- `class` | ||
### `class` | ||
|
||
The `class` attribute is special. It behaves differently when you pass a Hash as a value, allowing you to conditionally add classes. Here, the class `active` is added because `is_active` is _truthy_, and the class `disabled` is not added because `is_disabled` is _falsy_: | ||
|
||
::: code-group | ||
|
||
```ruby [component] | ||
is_active = true | ||
is_disabled = false | ||
|
||
a(class: { active: is_active, disabled: is_disabled }) { "Click me" } | ||
``` | ||
|
||
```html [output] | ||
<a class="active">👋 Hello World!</a> | ||
``` | ||
|
||
::: | ||
|
||
You can also use this with an array: | ||
|
||
::: code-group | ||
|
||
```ruby{6} [component] | ||
is_active = true | ||
is_disabled = false | ||
a( | ||
class: [ | ||
"button", | ||
"active" => is_active, | ||
"disabled" => is_disabled | ||
] | ||
) { "Click me" } | ||
``` | ||
|
||
```html [output] | ||
<a class="button active">👋 Hello World!</a> | ||
``` | ||
|
||
In this example, the `button` class is always added, while the `active` and `disabled` classes are conditional. You can read `=>` as “if”. | ||
|
||
### `style` | ||
|
||
Like `class`, the `style` attribute has special behaviour. If you pass a Hash to `style`, Phlex will convert it to a CSS string: | ||
|
||
::: code-group | ||
|
||
```ruby [component] | ||
h1(style: { color: "red", font_size: "16px" }) { "Hello!" } | ||
``` | ||
|
||
```html [output] | ||
<h1 style="color: red; font-size: 16px;">Hello!</h1> | ||
``` | ||
|
||
::: | ||
|
||
### `href` on an `<a>` tag | ||
|
||
It’s worth noting here that Phlex will not allow you to set the `href` attribute to anything that begins with `javascript:`. This is a security feature to prevent cross-site-scripting (XSS) attacks. | ||
|
||
## Event attributes | ||
|
||
Event attributes such as `onclick` are disallowed to prevent cross-site-scripting (XSS) attacks. |