blob: 800d446478486ce244348e71ceecdb4dd2f4b3e9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
# MozPageNav
`moz-page-nav` is a grouping of navigation buttons that is displayed at the page level,
intended to change the selected view, provide a heading, and have links to external resources.
```html story
<moz-page-nav heading="This is a nav" style={{ '--page-nav-margin-top': 0, '--page-nav-margin-bottom': 0, height: '200px' }}>
<moz-page-nav-button
view="view-one"
iconSrc="chrome://browser/skin/preferences/category-general.svg"
>
<p style={{ margin: 0 }}>Test 1</p>
</moz-page-nav-button>
<moz-page-nav-button
view="view-two"
iconSrc="chrome://browser/skin/preferences/category-general.svg"
>
<p style={{ margin: 0 }}>Test 2</p>
</moz-page-nav-button>
<moz-page-nav-button
view="view-three"
iconSrc="chrome://browser/skin/preferences/category-general.svg"
>
<p style={{ margin: 0 }}>Test 3</p>
</moz-page-nav-button>
</moz-page-nav>
```
## When to use
* Use moz-page-nav for single-page navigation to switch between different views.
* moz-page-nav will also support footer buttons for external support links in the future (See [bug 1877826](https://bugzilla.mozilla.org/show_bug.cgi?id=1877826))
* This component will be used in about: pages such as about:firefoxview, about:preferences, about:addons, about:debugging, etc.
## When not to use
* If you need a navigation menu that does not switch between views within a single page
## Code
The source for `moz-page-nav` and `moz-page-nav-button` can be found under
[toolkit/content/widgets/moz-page-nav](https://searchfox.org/mozilla-central/source/toolkit/content/widgets/moz-page-nav).
You can find an examples of `moz-page-nav` in use in the Firefox codebase in
[about:firefoxview](https://searchfox.org/mozilla-central/source/browser/components/firefoxview/firefoxview.html#52-87).
`moz-page-nav` can be imported into `.html`/`.xhtml` files:
```html
<script type="module" src="chrome://global/content/elements/moz-page-nav.mjs"></script>
```
And used as follows:
```html
<moz-page-nav>
<moz-page-nav-button
view="A name for the first view"
iconSrc="A url for the icon for the first navigation button">
</moz-page-nav-button>
<moz-page-nav-button
view="A name for the second view"
iconSrc="A url for the icon for the second navigation button">
</moz-page-nav-button>
<moz-page-nav-button
view="A name for the third view"
iconSrc="A url for the icon for the third navigation button">
</moz-page-nav-button>
</moz-page-nav>
```
### Fluent usage
Generally the `heading` property of
`moz-page-nav` will be provided via [Fluent attributes](https://mozilla-l10n.github.io/localizer-documentation/tools/fluent/basic_syntax.html#attributes).
To get this working you will need to specify a `data-l10n-id` as well as
`data-l10n-attrs` if you're providing a heading:
```html
<moz-page-nav data-l10n-id="with-heading"
data-l10n-attrs="heading"></moz-page-nav>
```
In which case your Fluent messages will look something like this:
```
with-heading =
.heading = Heading text goes here
```
You also need to specify a `data-l10n-id` for each `moz-page-nav-button`:
```html
<moz-page-nav-button data-l10n-id="with-button-text"></moz-page-nav-button>
```
```
with-button-text = button text goes here
```
|
