Skip to content

Commit 083860d

Browse files
committed
Added tutorial content for basic and advanced functionality; still need to add screenshots
1 parent 9f0eb33 commit 083860d

File tree

3 files changed

+56
-10
lines changed

3 files changed

+56
-10
lines changed

src/components/dashboard_items/GetStarted.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
</q-tab>
1818
<q-tab
1919
name="basics"
20-
label="Basic Functions"
20+
label="The Basics"
2121
id="label-text"
2222
>
2323
</q-tab>

src/components/dashboard_items/tutorial/AdvancedFunctions.vue

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,22 @@
11
<template>
22
<!--Typescript option, mock image?, nested HTML elements, import component/limitations -->
33
<section id="advancedFunctions">
4-
<h6 class="tutorialHeading">Advanced Functions Here!</h6>
5-
<p class="tutorialContent">Some fancier functionality here</p>
4+
<h6 class="tutorialHeading">Advanced Functionality</h6>
5+
<h class="tutorial-sub-heading">Importing an existing component</h>
6+
<p class="tutorialContent">To import an existing Vue component file, open the Import Component sub-menu in the left sidebar and click 'Import Component'.
7+
</p>
8+
<h class="tutorial-sub-heading">Adding Props</h>
9+
<p class="tutorialContent">To add props, select the component and click the Props sub-menu in the Update Component menu in the left sidebar. Enter the name of the prop you want to add and click ‘+’ or press enter. Then select the added prop(s) from the dropdown and click the 'Add' Prop(s)’ button. To remove a prop, click the ‘x’ icon on the right side of the prop.
10+
</p>
11+
<h class="tutorial-sub-heading">Adding State or Actions</h>
12+
<p class="tutorialContent">To add state or actions to a component, they must first be added to the store. Under the Store tab, click on Store State or Store Actions, enter the name and click the ‘+’ or press enter. Then, select the component to which you want to add state or actions. In the State or Actions sub-menus in the Update Component menu of the left sidebar, select your desired state(s) or action(s) from the dropdown and click ‘Map State’ or ‘Map Actions’. To remove them, click the ‘x’ icon on the right side of the state or action.
13+
</p>
14+
<h class="tutorial-sub-heading">Navigating HTML elements</h>
15+
<p class="tutorialContent">To nest HTML elements, select a component, click the double down arrow icon on an HTML element (either in the HTML Elements sub-menu of the Update Component menu in the left sidebar or the HTML Elements sub-menu of the Component Details tab in the right sidebar). Click the icons to add additional HTML elements. To navigate back up a layer, click the up arrow icon. (Note: Certain types of HTML elements cannot be nested, these will not have a double arrow icon.)
16+
</p>
17+
<h class="tutorial-sub-heading">TypeScript Mode</h>
18+
<p class="tutorialContent">To turn TypeScript mode on or off, click on the Settings gear icon in the right corner of the nav bar and click the toggle at the bottom of the menu.
19+
</p>
620
<q-btn
721
class="tut-btn"
822
color="secondary"
@@ -28,16 +42,24 @@ export default {
2842
flex-direction: column;
2943
justify-content: center;
3044
align-items: center;
45+
margin: 10px;
3146
}
3247
3348
.tutorialHeading {
3449
margin: .75rem;
3550
font-size: 2rem;
3651
padding-top: 15px;
3752
}
38-
53+
.tutorial-sub-heading{
54+
align-self: flex-start;
55+
font-size: 1.4rem;
56+
margin: .75rem;
57+
margin-bottom: 0px;
58+
}
3959
.tutorialContent {
4060
margin: .75rem;
61+
align-self: flex-start;
62+
font-size: 1rem;
4163
}
4264
4365
.tut-btn {

src/components/dashboard_items/tutorial/BasicFunctions.vue

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,41 @@
66
you to integrate this tool into your design process for creating Vue applications.
77
</p><br>
88
<h class="tutorial-sub-heading">Navigating OverVue</h>
9-
<p class="tutorialContent">If you ever want to navigate back to this page, click the gear icon <img style="vertical-align:middle" alt="Gear" src="../../../assets/gear.png" id="tut-image"> in the top navigation bar, all the way to the right, and select "Getting Started"
9+
<p class="tutorialContent">If you ever want to navigate back to this page, click the gear icon <img style="vertical-align:middle" alt="Gear" src="../../../assets/gear.png" class="tut-image"> in the top navigation bar, all the way to the right, and select "Getting Started"
1010
to return to the landing page.
1111
</p>
12-
<p class="tutorialContent">Almost any action in OverVue can be reversed with 'undo' or recreated with 'redo' <img style="vertical-align:middle" alt="Undo-redo" src="../../../assets/undo_redo.png" id="tut-image"> found on
12+
<p class="tutorialContent">Almost any action in OverVue can be reversed with 'undo' or recreated with 'redo' <img style="vertical-align:middle" alt="Undo-redo" src="../../../assets/undo_redo.png" class="tut-image"> found on
1313
the left side of the top navigation bar. You can also utilize keyboard shortcuts (cmd-z or ctrl-z to undo; cmd-y or ctrl-y to redo) to accomplish the same thing as clicking the buttons.
1414
</p>
1515
<p class="tutorialContent">There are three additional buttons on the top navigation bar to utilize: Save, Import and Export.
1616
</p>
1717
<p class="tutorialContent">
18-
<img style="vertical-align:middle" alt="save" src="../../../assets/save.png" id="tut-image">Save text here<br>
19-
<img style="vertical-align:middle" alt="import" src="../../../assets/import.png" id="tut-image">Import text here<br>
20-
<img style="vertical-align:middle" alt="export" src="../../../assets/export.png" id="tut-image">Export text here<br>
18+
<img style="vertical-align:middle" alt="save" src="../../../assets/save.png" class="tut-image">Save your OverVue project progress as a JSON file to access it again later<br>
19+
<img style="vertical-align:middle" alt="import" src="../../../assets/import.png" class="tut-image">Open an existing JSON project file or import an existing Vue component <br>
20+
<img style="vertical-align:middle" alt="export" src="../../../assets/export.png" class="tut-image">Export boilerplate code for your whole project or a single component<br>
21+
</p>
22+
<p class="tutorialContent">In the right sidebar, you'll find the Routes, Project Tree, and Component Details tabs:</p>
23+
<h class="tutorial-sub-heading">Routes</h>
24+
<p class="tutorialContent">You can find all your routes in the Routes tab. To add a route, enter the name in the input field and click the ‘+’ or press enter. Once added, you can click on a route to navigate to it. To delete a route, click on the ‘x’ on the right side of the route block. (Note: The default route HomeView cannot be deleted.)
25+
</p>
26+
<h class="tutorial-sub-heading">Uploading mockups</h>
27+
<p class="tutorialContent">You can upload a design mockup in the Routes tab of the right sidebar menu (one mockup per route). Select the route in the Routes tab, open the ‘Upload Mockup’ sub-menu and click ‘Upload Mockup’. To clear the image, click the ‘Clear Image’ button.
28+
</p>
29+
<h class="tutorial-sub-heading">Project Tree</h>
30+
<p class="tutorialContent">You can find a visualization of your app hierarchy in the Project Tree tab of the right sidebar. Routes are blue, components are green. You can also navigate to a component or route by clicking on it in the project tree.
31+
</p>
32+
<h class="tutorial-sub-heading">Component Details</h>
33+
<p class="tutorialContent">Under the component details tab, you can access details about the active/selected component - including a code snippet (live generated boilerplate code), the HTML elements, state, actions or props in the component.
34+
</p>
35+
<p class="tutorialContent">In the left sidebar, you’ll find the Component and Store tabs:</p>
36+
<h class="tutorial-sub-heading">Creating a component from scratch</h>
37+
<p class="tutorialContent">Under the Create Component menu in the left sidebar, set a component name (required) and optionally select a parent component, and/or html elements to be nested inside the component (see Advanced Functionality to add deeper nesting to html elements).
38+
</p>
39+
<h class="tutorial-sub-heading">Editing a component</h>
40+
<p class="tutorialContent">To update a component, select the component on the canvas and an Update Component menu will appear in the left sidebar. To update the name, enter the new name in the field and click enter.
41+
</p>
42+
<h class="tutorial-sub-heading">Deleting a component</h>
43+
<p class="tutorialContent">To delete a component, select it and click ‘Delete Currently Selected’ in the Update Component menu or press the delete key.
2144
</p>
2245
<q-btn
2346
class="tut-btn"
@@ -48,6 +71,7 @@ export default {
4871
flex-direction: column;
4972
justify-content: center;
5073
align-items: center;
74+
margin: 10px;
5175
}
5276
5377
.tutorialHeading {
@@ -75,7 +99,7 @@ export default {
7599
height: auto;
76100
}
77101
78-
#tut-image {
102+
.tut-image {
79103
margin: 4px;
80104
}
81105
</style>

0 commit comments

Comments
 (0)