You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: PatternFly 4 - Wireframe library and template/Wireframe kit guideline.md
+12-15Lines changed: 12 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
# Wireframe kit
2
-
The PF Wireframe library for Sketch is the perfect companion to the PatternFly design kit. If you’re familiar with designing mockups with the PF design kit you'll be able to adjust quickly to designing wireframes with the PF Wireframe library.
2
+
The PatternFly (PF) Wireframe library for Sketch is the perfect companion to the PatternFly design kit. If you’re familiar with designing mockups with the PF design kit you'll be able to adjust quickly to designing wireframes with the PF Wireframe library.
3
3
Ultimately, the PF Wireframe library will serve as a tool to speed up your ideation process and allow you to design and iterate designs more quickly before upgrading them to high fidelity.
4
4
5
5
It includes:
6
6
* A Wireframe library that allows you to design and iterate designs more quickly before upgrading them to high fidelity. Hosted on Sketch Cloud [here](https://www.sketch.com/s/97d92966-7ad7-4207-a381-48fda3c080f8).
7
-
* A Wireframe template file that provides examples of low fidelity components in a context. Hosted on Sketch Cloud [here](https://www.sketch.com/s/0af9fc12-7b9e-49c1-8d36-a6a62385a413).
7
+
* A Wireframe template file that provides examples of low and medium fidelity components in a context. Hosted on Sketch Cloud [here](https://www.sketch.com/s/0af9fc12-7b9e-49c1-8d36-a6a62385a413).
8
8
9
9
## Low fidelity vs Medium fidelity
10
10
If we take the PF design kit as a reference of a tool used to produce high fidelity artifacts, then the PF Wireframe library will provide resources to produce artifacts at two different lower fidelity levels:
@@ -29,15 +29,15 @@ These kinds of wireframes are the most common and are usually the starting point
29
29
30
30
## How to start
31
31
### Download Wireframe font
32
-
The PatternFly Wireframe kit uses [Flow](https://fonts.google.com/specimen/Flow+Circular) for LO-FI components and [Comic Neue](https://fonts.google.com/specimen/Comic+Neue#standard-styles) for MID-FI components.
32
+
The PatternFly Wireframe kit uses [Flow](https://fonts.google.com/specimen/Flow+Circular) for LO-FI components and [Comic Neue](https://fonts.google.com/specimen/Comic+Neue#standard-styles) for MID-FI components. Both font families are released under a OFL (Open Font License) license.
33
33
34
34
### Download the template file
35
35
* Access the PatternFly Wireframe template file on Sketch cloud [here](https://www.sketch.com/s/0af9fc12-7b9e-49c1-8d36-a6a62385a413).
36
36
* Click Download in the document menu to download the file locally
37
-
***OPTIONAL:** Open the PatternFly Wireframe template.sketch file. Then click File → Save as template. (This would allow you to create a new file from the “New from Template” menu)
37
+
***OPTIONAL:** Open the `PatternFly Wireframe template.sketch` file, then click File → Save as template. (This would allow you to create a new file from the “New from Template” menu)
38
38
39
39
### Add the library
40
-
* Access the PatternFly Wireframe - beta on Sketch cloud [here](https://www.sketch.com/s/97d92966-7ad7-4207-a381-48fda3c080f8).
40
+
* Access the PatternFly Wireframe library on Sketch cloud [here](https://www.sketch.com/s/97d92966-7ad7-4207-a381-48fda3c080f8).
41
41
* Click Add Library in the document menu to add the library to Sketch.
42
42
* You'll be prompted with a modal that will either redirect you to Sketch or ask you to Launch Sketch.
43
43
Sketch will automatically open up the preferences window pane and display the library installation progress.
@@ -51,10 +51,10 @@ In order to speed up your process, we highly suggest to start creating your wire
51
51
* Locate components
52
52
* Swap components (for example, when turning a lo-fi screen into a mid-fi screen)
53
53
* The menu follows the structure below
54
-
* Component family
55
-
* Fidelity (LO-FI/MID-FI)
56
-
* Variants
57
-
* State (MID-FI components only)
54
+
*`Component family`
55
+
* `Fidelity (LO-FI/MID-FI)`
56
+
* `Variants`
57
+
* `State (MID-FI components only)`
58
58
59
59
<imgsrc="../img/image20.png"width="700"/>
60
60
@@ -73,7 +73,7 @@ For this reason, we tried to make it as easy as possible to swap your components
73
73
<br /> <imgsrc="../img/image9.png"width="600"/>
74
74
* Follow the ticks to identify the component family
75
75
<br /> <imgsrc="../img/image16.png"width="500"/>
76
-
* Select the **MID-FI** version of the component
76
+
* Select the desired **MID-FI** version of the component
77
77
78
78
### MID-FI component state
79
79
* Select the component you want to swap
@@ -114,16 +114,13 @@ If you need to create any custom symbols and/or content, you can use the provide
114
114
## Report issues
115
115
Are you finding any bugs while using the library (eg. symbol not resizing correctly)? Or did you maybe encounter any usability issues (eg. can’t switch fidelity, overrides not working)? Or maybe you would like a new component or design pattern to be added to the library and/or template file?
116
116
Please do the following:
117
-
* Go to Issues · [patternfly/patternfly-design-kit](https://github.com/patternfly/patternfly-design-kit) · GitHub
117
+
* Go to [Issues · patternfly/patternfly-design-kit](https://github.com/patternfly/patternfly-design-kit/issues)
118
118
* Open/create a new issue
119
-
* Make sure to ping @cntlsn (Alessandro Contini) in the description of the issue
119
+
* Make sure to ping `@cntlsn` (Alessandro Contini) in the description of the issue
120
120
121
121
## Share your feedback
122
122
Do you have any feedback about your experience creating wireframes with the PF Wireframe library? For example:
123
123
* Do you create wireframes at both fidelities? If not, which one do you default to the most?
124
124
* When designing wireframes, do you prefer to have ready-made “complex” components with fewer customization options, or would you rather have simple components to manually assemble into complex ones?
125
125
* Do wireframes work better for stakeholder review, and do stakeholders realize it’s a low-fidelity version of mockups? Do stakeholders feel more comfortable sharing feedback?
126
126
If you want to share similar feedback please submit the following [survey](https://forms.gle/dEFxamLHFRxBvZRN8) – It shouldn’t take more than 10-15 minutes to complete the survey.
127
-
128
-
## Contribute
129
-
Do you also think this project is great and has the potential to change the course of our species?!? Or are you maybe feeling impatient about adding a new component (for instance the one you need right now in order to move forward with your wireframe) to the library?? Great! Join our group of lovely and fun UXDers on the #pf-wireframe-sketch-lib channel of the RHUX Slack space. Or reach out to Alessandro Contini [acontini@redhat](mailto:[email protected]).
0 commit comments