Skip to content

Commit

Permalink
Use permalinks
Browse files Browse the repository at this point in the history
  • Loading branch information
willeastcott committed Feb 4, 2024
1 parent 53c88b3 commit c518bee
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/pages/api.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: page
title: API
permalink: /api/
---

The graph API can be used to programmatically interact with a graph you have instantiated. You can control the view of the graph using the translate / scale functions as well as create / delete / update graph nodes and edges. The full API is documented [here](https://api.playcanvas.com/modules/PCUIGraph.html).
1 change: 1 addition & 0 deletions docs/pages/config-options.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: page
title: Config Options
permalink: /config-options/
---

Options can be passed to the graph constructor as a JSON object which change the default behavior of the graph. You can do so as follows:
Expand Down
1 change: 1 addition & 0 deletions docs/pages/context-menus.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: page
title: Context Menus
permalink: /context-menus/
---

It is possible to create context menus on your graph which display when right clicking various graph items. There are three types of context menus; background, node and edge. You can define a set of actions which will display in each of these menus and each action item in the menu will fire an action event when selected.
Expand Down
1 change: 1 addition & 0 deletions docs/pages/events.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: page
title: Events
permalink: /events/
---

After creating a graph, you can register a callback for various events. This is achieved using the graphs [on function](https://api.playcanvas.com/classes/PCUIGraph.Graph.html#on). The following events are supported:
Expand Down
1 change: 1 addition & 0 deletions docs/pages/schema.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: page
title: Schema
permalink: /schema/
---

The schema object is used to define what type of graph you will be initializing. More specifically, it defines which node your graph can contain and how those nodes can be connected together with edges.
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/storybook.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: page
title: Storybook
title: Storybook
permalink: /storybook-docs/
---

The storybook showcases PCUI-Graph's Graph component in a number of different contexts.
Expand Down
1 change: 1 addition & 0 deletions docs/pages/styling.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: page
title: Styling
permalink: /styling/
---

You can style your graph by overriding it's default style properties. This can be achieved by modifying the defaultStyles passed in as part of an options object to the graph constructor.
Expand Down

0 comments on commit c518bee

Please sign in to comment.