This repository was archived by the owner on Aug 17, 2020. It is now read-only.
forked from FirefoxUX/photon
-
Notifications
You must be signed in to change notification settings - Fork 4
First iteration of Panes documentation #34
Open
DPX-designer
wants to merge
2
commits into
master
Choose a base branch
from
pane-doc-v1
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,209 @@ | ||
| --- | ||
| layout: page | ||
| title: Panes | ||
| order: 7 | ||
| draft: true | ||
| --- | ||
|
|
||
| Panes are the visual containers which separate and group tools by areas of functionality. An example would be the Breakpoints pane in the Debugger, which groups all controls which govern the creation, deletion and management of breakpoints. | ||
|
|
||
| Panes are themselves often grouped together to form a panel. The Layout panel for example, contains the Flex Container, Grid and Box Model panes. | ||
|
|
||
| ## Usage | ||
|
|
||
| <div class="grid-2" markdown="1"> | ||
|  | ||
|
|
||
| <div markdown="1"> | ||
| A pane should be used when a series of controls which relate to the same task or piece of functionality need to be visually grouped under a single umbrella term. | ||
| </div> | ||
| </div> | ||
|
|
||
|
|
||
| ## Structure | ||
|
|
||
| Striped of their unique content, a pane is simply a container for other elements and controls. A pane has a header, a bar which runs the width of the pane and is positioned at the very top of the pane. The header must contain the following item: | ||
|
|
||
| ### Pane Title | ||
|
|
||
| <div class="grid-2" markdown="1"> | ||
|  | ||
|
|
||
| <div markdown="1"> | ||
| The pane title appears to the right of the arrow icon (or simply left aligned in the event that the panel does not expand or collapse) and provides a fitting label to the grouped content within the pane. | ||
| </div> | ||
| </div> | ||
|
|
||
| In addition to the required element above, a header can also contain: | ||
|
|
||
| ### Arrow (expand/collapse) | ||
|
|
||
| <div class="grid-2" markdown="1"> | ||
|  | ||
|
|
||
| <div markdown="1"> | ||
| The arrow icon indicates that a particular pane can be expanded and collapsed and what the current expanded state is (a downward pointing arrow indicates that the pane is expanded). When present, The arrow appears as the leftmost element in the pane header. | ||
| </div> | ||
| </div> | ||
|
|
||
| ### Button(s) | ||
|
|
||
| <div class="grid-2" markdown="1"> | ||
|  | ||
|
|
||
| <div markdown="1"> | ||
| Primary functions belonging to a pane may be exposed within the pane header to increase visibility and to reduce the need for an additional toolbar. | ||
|
|
||
| The Watch Expressions pane in the Debugger is a good example, the pane header offers an “Add Watch Expression” button (represented by a plus symbol) allowing users to quickly add new expressions. | ||
| Functional buttons must appear right aligned within the pane header. | ||
| </div> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Style | ||
|
|
||
| <div data-tabs> | ||
| <input type="radio" name="tstyle" id="style-generic" checked="checked"> | ||
| <label for="style-generic">Light</label> | ||
| <div data-tab markdown="1"> | ||
|
|
||
| ### Color | ||
|
|
||
| <div class="grid-2" markdown="1"> | ||
|  | ||
|
|
||
| <div markdown="1"> | ||
| #### Pane | ||
|
|
||
| Background: white `#ffffff` | ||
|
|
||
| Border/Splitter: Grey 25 `#e0e0e2` | ||
|
|
||
| #### Header | ||
|
|
||
| Background: Grey 10 `#f9f9fa` | ||
|
|
||
| Text: Grey 90 `#0c0c0d` | ||
|
|
||
| Arrow: `rgba(0, 0, 0, 0.3)` | ||
|
|
||
| Icon: Grey 60 `#4a4a4f` | ||
|
|
||
| #### Header Hover | ||
|
|
||
| Background: Grey 20 `#ededf0` | ||
|
|
||
| Cursor: `default` | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
|
|
||
| <input type="radio" name="tstyle" id="style-success"> | ||
| <label for="style-success">Dark</label> | ||
| <div data-tab markdown="1"> | ||
|
|
||
| ### Color | ||
|
|
||
| <div class="grid-2" markdown="1"> | ||
|  | ||
|
|
||
| <div markdown="1"> | ||
| #### Pane | ||
|
|
||
| Background: Grey 85 `#1b1b1d` | ||
|
|
||
| Border/Splitter: `#3c3c3d` *Photon color needed* | ||
|
|
||
| #### Header | ||
|
|
||
| Background: `#222225` *Photon color needed* | ||
|
|
||
| Text: Grey 40 `#b1b1b3` | ||
|
|
||
| Arrow: `rgba(255, 255, 255, 0.4)` | ||
|
|
||
| Icon: Grey 40 `#b1b1b3` | ||
|
|
||
| #### Header Hover | ||
|
|
||
| Background: Grey 80 `#2a2a2e` | ||
|
|
||
| Cursor: `default` | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ### Sizes | ||
|
|
||
| <div class="grid-2" markdown="1"> | ||
|  | ||
|
|
||
| <div markdown="1"> | ||
|
|
||
| #### Pane | ||
|
|
||
| Padding `4px 20px` | ||
|
|
||
| #### Header | ||
|
|
||
| Height: `24px` | ||
|
|
||
| Text: `12px, regular 400` | ||
|
|
||
| Padding: `4px 20px` | ||
|
|
||
| **Note:** The 20px left padding is the sum of 6px padding either side of the 8px arrow icon. | ||
|
|
||
| </div> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
| <div class="grid-2" markdown="1"> | ||
|  | ||
|
|
||
| <div markdown="1"> | ||
|
|
||
| #### Arrow | ||
|
|
||
| Width: `8px` | ||
|
|
||
| Height: `8px` | ||
|
|
||
| Containing an `8px` x `5px` SVG | ||
|
|
||
| #### Icons | ||
|
|
||
| width: `10px` | ||
|
|
||
| height: `10px` | ||
|
|
||
| </div> | ||
| </div> | ||
|
|
||
|
|
||
| ## Behaviours | ||
|
|
||
| ### Expand and collapse | ||
|
|
||
| <div class="grid-2" markdown="1"> | ||
|  | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If you look at https://github.com/FirefoxUX/photon/pull/334/files#diff-80eddb616ebe9c94995bc02d10ea6519R30 you'll see that we recently added the ability to have a play/pause frame for animations, by adding the line: |
||
|
|
||
| <div markdown="1"> | ||
| Panes which include an arrow icon within the header indicate that their content can be expanded or collapsed. | ||
|
|
||
| The expanded state is toggled by single clicking the header and any element within it excluding buttons. | ||
|
|
||
| When a pane is collapsed only the pane header is visible. | ||
| </div> | ||
| </div> | ||
|
|
||
This file contains hidden or 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
This file contains hidden or 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,7 +1,7 @@ | ||
| --- | ||
| layout: page | ||
| title: Splitters | ||
| order: 8 | ||
| order: 9 | ||
| draft: true | ||
| --- | ||
|
|
||
|
|
||
This file contains hidden or 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,7 +1,7 @@ | ||
| --- | ||
| layout: page | ||
| title: Tables | ||
| order: 9 | ||
| order: 10 | ||
| draft: true | ||
| --- | ||
|
|
||
|
|
||
This file contains hidden or 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,7 +1,7 @@ | ||
| --- | ||
| layout: page | ||
| title: Trees | ||
| order: 10 | ||
| order: 11 | ||
| draft: true | ||
| --- | ||
|
|
||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we link to one of the SVGs from the photon-icons site?