Skip to content

Commit

Permalink
updated extension guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Florian committed Jun 13, 2016
1 parent f674595 commit d2106e6
Showing 1 changed file with 1 addition and 9 deletions.
10 changes: 1 addition & 9 deletions tutorials/extension.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# How to develop a complete extension
# How to develop an extension

<p class="uk-article-lead">This tutorial follows all steps needed to setup and develop a full extension to manage Todo items in the admin area of Pagekit. You will learn about basic extension concepts, controllers, routing, view rendering and the Vue.js framework.</p>

Expand All @@ -17,8 +17,6 @@ If you prefer video instead of text, check out the [Youtube playlist with all sc

**Note** The [completed example](https://github.com/pagekit/example-todo) is available on Github.

---

## Step 1: Extending Pagekit using Modules

<p class="uk-article-lead">As a developer, you can easily extend what Pagekit already offers. Whether you want a custom theme or an extension for additional functionality, both are built following the same approach. In this first step we will introduce what a *package* and what a *module* is - both central concepts of Pagekit.</p>
Expand Down Expand Up @@ -94,8 +92,6 @@ In order to test the functionality, make sure you enable the extension in the ba

This minimal example shows how small a fully functional module can be. It has access to the `Application` instance. With this object you can access all services, trigger events and listen to events triggered by other modules.

---

## Step 2: Routing and Controller

<p class="uk-article-lead">With the basic structure of an extension set up, a common task is to register your own controllers and add menu items to the admin area. For that, we will look at some additional properties that you can add to the module definition in your `index.php`.</p>
Expand Down Expand Up @@ -191,8 +187,6 @@ To add menu items use the `menu` property in your module definition. Add the fol

Refresh the Pagekit backend and you will see a new menu item which links to the `@todo` route.

---

## Step 3: View rendering and module config

<p class="uk-article-lead">In the past steps, we have looked at the basics of modules and routing. However, our first controller only returned simple strings. In this step, let us look at actual view rendering.</p>
Expand Down Expand Up @@ -271,8 +265,6 @@ We can store changes to the module config in the database. The changes from the
App::config('todo')->set('entries', $entries);
```

---

## Step 4: Using Vue.js in a Pagekit extension

<p class="uk-article-lead">When building your own screens for the admin area, you can use any library you are used to. But as Pagekit comes with Vue.js included, it makes sense to look into it and see if it's the right choice for you as well. In this step, we will be introducing the basic concepts of working with Vue.js inside Pagekit.</p>
Expand Down

0 comments on commit d2106e6

Please sign in to comment.