Skip to content

Commit f3fed13

Browse files
authored
Merge pull request #32 from oslabs-beta/David/tutorial
David/tutorial
2 parents 914aa3f + d1ed5d8 commit f3fed13

17 files changed

+82
-186
lines changed

src/assets/delete-component.png

-7.22 KB
Loading

src/assets/export.png

-6.93 KB
Loading

src/assets/import.png

-6.94 KB
Loading

src/assets/interactive-tree.png

62.5 KB
Loading

src/assets/modal.png

39.3 KB
Loading

src/assets/nested-elements.png

33.5 KB
Loading

src/assets/props.png

-18.8 KB
Loading

src/assets/routes.png

-12.1 KB
Loading

src/assets/save.png

-7.07 KB
Loading

src/assets/state-actions.png

-7.68 KB
Loading

src/assets/tree.png

13.4 KB
Loading

src/assets/vuetensils.png

14.9 KB
Loading

src/components/right-sidebar/GetStarted.vue

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -48,29 +48,6 @@ import { ref } from "vue";
4848
const tutorialPage = ref("landing");
4949
</script>
5050

51-
<!-- OLD OPTIONS API SYNTAX -->
52-
<!-- <script lang="ts">
53-
import BasicFunctions from './tutorial/BasicFunctions.vue'
54-
import AdvancedFunctions from './tutorial/AdvancedFunctions.vue'
55-
import Landing from './tutorial/Landing.vue'
56-
import NewVersionInfo from './tutorial/NewVersionInfo.vue'
57-
import { defineComponent } from "vue";
58-
59-
export default defineComponent({
60-
components: {
61-
BasicFunctions,
62-
AdvancedFunctions,
63-
Landing,
64-
NewVersionInfo
65-
},
66-
data() {
67-
return {
68-
tutorialPage: 'landing' as string,
69-
}
70-
}
71-
});
72-
</script> -->
73-
7451
<style lang="scss" scoped>
7552
.q-btn {
7653
font-size: 8px;

src/components/right-sidebar/tutorial/AdvancedFunctions.vue

Lines changed: 1 addition & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
<template>
2-
<!--Typescript option, mock image?, nested HTML elements, import component/limitations -->
32
<section id="advancedFunctions">
43
<h6 class="tutorialHeading">Advanced Functionality</h6>
54
<h class="tutorial-sub-heading">Importing an existing component</h>
@@ -10,11 +9,6 @@
109
formats is not currently supported.
1110
</p>
1211
<h class="tutorial-sub-heading">Adding Props</h>
13-
<img
14-
alt="Props sub-menu"
15-
src="../../../assets/props.png"
16-
class="tut-screenshot"
17-
/>
1812
<p class="tutorialContent">
1913
To add props, select the component and click the Props sub-menu in the
2014
Update Component menu in the left sidebar. Enter the name of the prop you
@@ -24,7 +18,7 @@
2418
</p>
2519
<img
2620
alt="Add Props"
27-
src="../../../assets/add-props.png"
21+
src="../../../assets/props.png"
2822
class="tut-screenshot"
2923
/>
3024
<h class="tutorial-sub-heading">Adding State or Actions</h>
@@ -43,21 +37,6 @@
4337
src="../../../assets/state-actions.png"
4438
class="tut-screenshot"
4539
/>
46-
<h class="tutorial-sub-heading">Navigating HTML elements</h>
47-
<p class="tutorialContent">
48-
To nest HTML elements, select a component, click the double down arrow
49-
icon on an HTML element (either in the HTML Elements sub-menu of the
50-
Update Component menu in the left sidebar or the HTML Elements sub-menu of
51-
the Component Details tab in the right sidebar). Click the icons to add
52-
additional HTML elements. To navigate back up a layer, click the up arrow
53-
icon. (Note: Certain types of HTML elements cannot be nested, these will
54-
not have a double arrow icon.)
55-
</p>
56-
<img
57-
alt="HTML Queue"
58-
src="../../../assets/html-queue.png"
59-
class="tut-screenshot"
60-
/>
6140
<h class="tutorial-sub-heading">TypeScript Mode</h>
6241
<p class="tutorialContent">
6342
To turn TypeScript mode on or off, click on the Settings gear icon in the
@@ -87,17 +66,6 @@ const store = useStore();
8766
const toggleTutorial = () => store.toggleTutorial();
8867
</script>
8968

90-
<!-- OLD OPTIONS API SYNTAX -->
91-
<!-- <script>
92-
import { mapActions } from "vuex";
93-
94-
export default {
95-
methods: {
96-
...mapActions(["toggleTutorial"]),
97-
},
98-
};
99-
</script> -->
100-
10169
<style lang="scss" scoped>
10270
#advancedFunctions {
10371
display: flex;

src/components/right-sidebar/tutorial/BasicFunctions.vue

Lines changed: 28 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
<template>
2-
<!--Basic functionality here, add component, copy/paste, undo/redo, add html, saving, loading, exporting-->
32
<section id="basicFunctions">
43
<h6 class="tutorialHeading">Getting Started in OverVue</h6>
54
<p class="tutorialContent">
@@ -20,17 +19,6 @@
2019
in the top navigation bar, all the way to the right, and select "Getting
2120
Started" to return to the landing page.
2221
</p>
23-
<p class="tutorialContent">
24-
Almost any action in OverVue can be reversed with 'undo' or recreated with
25-
'redo'
26-
<img
27-
style="vertical-align: middle"
28-
alt="Undo-redo"
29-
src="../../../assets/undo_redo.png"
30-
class="tut-image"
31-
/>
32-
found on the left side of the top navigation bar.
33-
</p>
3422
<h class="tutorial-sub-heading">Setting Up Your Project</h>
3523
<p class="tutorialContent">
3624
Begin by clicking the gear icon
@@ -46,11 +34,6 @@
4634
Github. Boilerplate for these configurations will be reflected in your
4735
exported project.
4836
</p>
49-
<p class="tutorialContent">
50-
Next, customize your canvas grid by choosing a density for your width and
51-
height in the upper left corner of the page. Once you begin prototyping,
52-
elements will snap to the grid for easy positioning.
53-
</p>
5437
<h class="tutorial-sub-heading">Creating Components</h>
5538
<p class="tutorialContent">
5639
Under the Create Component menu in the left sidebar, set a component name
@@ -64,30 +47,41 @@
6447
class="tut-screenshot"
6548
/>
6649
<p class="tutorialContent">
67-
To use components from the Vue 3 compatible library, ElementPlus+, you can
68-
select elements from the dropdown menu, or search for them by element
69-
name. You will then select the corresponding html tag, designated with a
70-
prefix of 'e'. Finally, click create component!
50+
To use components from the Vue 3 compatible library, Vuetensils, you can
51+
switch the tab from Elements to Vuetensils. Finally, click create component!
7152
</p>
7253
<h class="tutorial-sub-heading">Customizing Your Components</h>
7354
<p class="tutorialContent">
7455
To capture component styling, be sure to add a class attribute. You can
7556
further customize your components in the sidebar by adding an id, parents,
7657
children, props, state, or actions - all of which will be included in your
7758
exported code. To update a component after its creation, select the
78-
component on the canvas and the Update Component Menu will appear in the
59+
component on the tree and the Update Component Menu will appear in the
7960
left sidebar.
8061
</p>
8162
<h class="tutorial-sub-heading">Building Out Your Prototype</h>
8263
<p class="tutorialContent">
83-
To manipuilate your prototype, you can drag and drop your components on
84-
the grid, and resize them by pulling at the corners. To add comments,
85-
click the notepad icon in the left corner of the component. To change
86-
color, click the canvas icon and select your color of choice.
64+
To manipulate your prototype, you can drag and drop your components on
65+
the tree. This will alter the component relationships and the code will
66+
reflect the changes. To control the tree view, you focus on the tree background
67+
by clicking it, and use keyboard controls to move around and zoom in.
68+
</p>
69+
<h class="controls">Controls:</h>
70+
<p class="tutorialContent">
71+
Directional Movement: Arrow Keys
72+
<br/>
73+
Zoom: Scroll Wheel | Comma ( , ) | Period ( . )
74+
<br/>
75+
Return to Root: Slash ( / )
8776
</p>
77+
<img
78+
alt="Tree View"
79+
src="../../../assets/tree.png"
80+
class="tut-screenshot"
81+
/>
8882
<h class="tutorial-sub-heading">Deleting Components</h>
8983
<p class="tutorialContent">
90-
To delete a component, select it and click ‘Delete Currently Selected’ in
84+
To delete a component, select it and click ‘Delete Current Component’ in
9185
the Update Component menu.
9286
</p>
9387
<img
@@ -120,22 +114,6 @@
120114
src="../../../assets/routes.png"
121115
class="tut-screenshot"
122116
/>
123-
<!-- <h class="tutorial-sub-heading">Uploading mockups</h>
124-
<p class="tutorialContent">You can upload a design mockup in the Routes tab of the right sidebar menu (one mockup
125-
per route). Select the route in the Routes tab, open the ‘Upload Mockup’ sub-menu and click ‘Upload Mockup’. To
126-
clear the image, click the ‘Clear Image’ button.
127-
</p>
128-
<img alt="Upload Mockup buttons" src="../../../assets/upload-mockups.png" class="tut-screenshot">
129-
<h class="tutorial-sub-heading">Project Tree</h>
130-
<p class="tutorialContent">You can find a visualization of your app hierarchy in the Project Tree tab of the right
131-
sidebar. Routes are blue, components are green. You can also navigate to a component or route by clicking on it in
132-
the project tree.
133-
</p> -->
134-
<img
135-
alt="Project Tree"
136-
src="../../../assets/project-tree.png"
137-
class="tut-screenshot"
138-
/>
139117
<h class="tutorial-sub-heading">Saving or Exporting Your Project</h>
140118
<p class="tutorialContent">
141119
When you are satisfied with your project, you can save it or export it
@@ -178,7 +156,6 @@
178156
</section>
179157
</template>
180158

181-
<!-- COMPOSITION API SYNTAX -->
182159
<script setup lang="ts">
183160
import { useStore } from "../../../store/main.js";
184161
@@ -189,21 +166,6 @@ const toggleTutorial = () => store.toggleTutorial();
189166
const nextTab = () => emit("nextTab");
190167
</script>
191168

192-
<!-- OLD OPTIONS API SYNTAX -->
193-
<!-- <script>
194-
import { mapActions } from 'vuex';
195-
196-
export default {
197-
emits: ['nextTab'],
198-
methods: {
199-
...mapActions(["toggleTutorial"]),
200-
nextTab() {
201-
this.$emit('nextTab')
202-
}
203-
}
204-
}
205-
</script> -->
206-
207169
<style scoped lang="scss">
208170
#basicFunctions {
209171
display: flex;
@@ -232,6 +194,13 @@ export default {
232194
font-size: 1rem;
233195
}
234196
197+
.controls {
198+
align-self: flex-start;
199+
font-size: 1.2rem;
200+
margin: 0.75rem;
201+
margin-bottom: 0px;
202+
}
203+
235204
.tut-btn {
236205
margin: 0.75rem;
237206
width: 50%;

src/components/right-sidebar/tutorial/Landing.vue

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
<template>
2-
<!--Landing page-->
32
<section id="welcomeTab">
43
<h6 class="tutorialHeading">Welcome to</h6>
54
<img
@@ -31,7 +30,6 @@
3130
</section>
3231
</template>
3332

34-
<!-- COMPOSITION API SYNTAX -->
3533
<script setup lang="ts">
3634
// @ts-nocheck
3735
// No check for the shell
@@ -47,24 +45,6 @@ const nextTab = () => emit("nextTab");
4745
const openUrl = (url: string) => shell.openExternal(url, { activate: true });
4846
</script>
4947

50-
<!-- OLD OPTIONS API SYNTAX -->
51-
<!-- <script>
52-
const { ipcRenderer, shell } = window;
53-
import { mapActions } from 'vuex';
54-
export default {
55-
emits: ['nextTab', 'versionTab'],
56-
methods: {
57-
...mapActions(["toggleTutorial"]),
58-
nextTab() {
59-
this.$emit('nextTab')
60-
},
61-
openUrl(url) {
62-
shell.openExternal(url, { activate: true });
63-
}
64-
}
65-
}
66-
</script> -->
67-
6848
<style lang="scss" scoped>
6949
#logo {
7050
width: 325px;

0 commit comments

Comments
 (0)