Skip to content

Commit

Permalink
Update the docs, add an example, minor typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Dominik Meyer authored and Dominik Meyer committed May 11, 2016
1 parent 62bc1c4 commit 4a2ea34
Show file tree
Hide file tree
Showing 10 changed files with 63 additions and 16 deletions.
2 changes: 1 addition & 1 deletion bower.json
View file
Expand Up @@ -29,13 +29,13 @@
"angular-bootstrap": "~0.13.3",
"bootstrap": "~3.3.5",
"google-code-prettify": "~1.0.4",
"Materialize": "materialize#~0.97.3",
"angular-mocks": "=1.5.5"
},
"devDependencies": {
"angular-mocks": "~1.5.5",
"bootstrap": "~3.3.5",
"google-code-prettify": "~1.0.4",
"Materialize": "materialize#~0.97.3",
"angular-bootstrap": "~0.13.3"
},
"resolutions": {
Expand Down
36 changes: 35 additions & 1 deletion docs/app/components/components.module.js
View file
Expand Up @@ -6,7 +6,8 @@

angular
.module('docApp')
.controller('exempleController', ['dashboardFactory', 'imagesComponent', Exemple1Controller]);
.controller('exempleController', ['dashboardFactory', 'imagesComponent', Exemple1Controller])
.controller('exemple2Controller', ['$scope', 'dashboardFactory', 'imagesComponent', Exemple2Controller]);

function Exemple1Controller(fluanceDashboard, ImageComponent) {

Expand All @@ -29,4 +30,37 @@
}
}

function Exemple2Controller($scope, fluanceDashboard, ImageComponent) {

var dashboard = fluanceDashboard.get('components-simple-exemple2');

$scope.toggleSortable = function() {
dashboard.toggleSortable();
};

if (dashboard.nbComponent === 0) {
var img = [
'https://images.unsplash.com/photo-1445251836269-d158eaa028a6?q=80&fm=jpg&w=800&fit=max',
'https://images.unsplash.com/photo-1442188950719-e8a67aea613a?q=80&fm=jpg&w=800&fit=max',
'https://images.unsplash.com/photo-1442029739115-ce733f0de45e?q=80&fm=jpg&w=800&fit=max',
'https://images.unsplash.com/photo-1444703686981-a3abbc4d4fe3?q=80&fm=jpg&w=800&fit=max',
'https://images.unsplash.com/photo-1444090542259-0af8fa96557e?q=80&fm=jpg&w=800&fit=max',
'https://images.unsplash.com/photo-1443827423664-eac70d49dd0d?q=80&fm=jpg&w=800&fit=max',
'https://images.unsplash.com/photo-1438368915865-a852ef86fc42?q=80&fm=jpg&w=800&fit=max',
'https://images.unsplash.com/photo-1443453489887-98f56bc5bb38?q=80&fm=jpg&w=800&fit=max',
'https://images.unsplash.com/photo-1441966055611-30ea468880a2?q=80&fm=jpg&w=800&fit=max',
'https://images.unsplash.com/photo-1441155472722-d17942a2b76a?q=80&fm=jpg&w=800&fit=max',
'https://images.unsplash.com/photo-1439546743462-802cabef8e97?q=80&fm=jpg&w=800&fit=max'
];

img.forEach(function(url) {
dashboard.add(new ImageComponent({
'url': url
}));
});
} else {
dashboard.disableExtended();
}
}

})();
2 changes: 1 addition & 1 deletion docs/app/components/images/images.templates.html
View file
@@ -1,6 +1,6 @@
<div class="row">
<div class="col s12">
<div class="card">
<div class="card sortable-handle">
<div class="card-image">
<img ng-src="{{ params.url }}">
<span class="card-title">Image component</span>
Expand Down
1 change: 1 addition & 0 deletions docs/app/index.html
View file
Expand Up @@ -38,6 +38,7 @@
<script src="../../bower_components/Sortable/Sortable.js"></script>
<script src="../../bower_components/Sortable/ng-sortable.js"></script>
<script src="../../bower_components/google-code-prettify/bin/prettify.min.js"></script>
<script src="../../bower_components/angular-mocks/angular-mocks.js"></script>
<script src="../../bower_components/Materialize/bin/materialize.js"></script>
<!-- endbower -->
<!-- endbuild -->
Expand Down
4 changes: 2 additions & 2 deletions docs/app/src/main.html
View file
Expand Up @@ -26,15 +26,15 @@ <h6><a class="btn-flat waves-effect nav-index-group-heading" ng-href="{{navGroup
<footer class="page-footer teal lighten-2">
<div class="container">
<div class="row">
<div class="col l8 s12">
<div class="col l6 s12">
<h5 class="white-text">About Angular Dashboard Fluance</h5>
<p class="grey-text text-lighten-4">Angular Dashboard Fluance is an implenentation of the dashboard design pattern for angularjs. It is a common base to build a strong and smart dashboard interface.<br/>Only defining Models-Controllers at a low level, it is <strong>CSS framework free</strong>, and build to <strong>fit any project</strong>.</p>
</div>
<div class="col l4 offset-l2 s12">
<h5 class="white-text">Shortcuts</h5>
<ul>
<li><a class="grey-text text-lighten-3" href="https://github.com/fluanceit/bower-angular-dashboard/releases">Download</a></li>
<li><a class="grey-text text-lighten-3" href="https://github.com/fluanceit/angular-dashboard/issues">Bug tracker</a></li>
<li><a class="grey-text text-lighten-3" href="https://github.com/fluanceit/angular-dashboard/issues">Issue tracker</a></li>
</ul>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/content/index.ngdoc
View file
Expand Up @@ -13,8 +13,8 @@
</div>
<div class="col s12 center-align">
<p class="center">
<a class="btn btn-primary btn-lg" href="presentation" role="button">What is it about ?</a>
<a class="btn btn-primary btn-lg" href="guide" role="button">How to use ?</a>
<a class="btn btn-primary btn-lg" href="presentation" role="button">What is it about?</a>
<a class="btn btn-primary btn-lg" href="guide" role="button">How to use?</a>
<a class="btn btn-primary btn-lg" href="presentation/examples" role="button">Examples</a>
</p>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/content/presentation/components.ngdoc
View file
Expand Up @@ -42,8 +42,8 @@ Here is an image component which use our the three views.

<div class="row">
<div class="col s12">
<h4>Live examples</h4>
<p>Since now you know all about our features and about components, you should give a look at some examples we build for you to see what should your final result looks like.</p>
<a class="btn btn-primary btn-lg left" href="#/presentation/examples" role="button">See some live examples</a>
<h4>Live example</h4>
<p>Since now you know all about our features and about components, you should give a look at the example we built for you to see what your final result should look like.</p>
<a class="btn btn-primary btn-lg left" href="#/presentation/examples" role="button">See a live example</a>
</div>
</div>
15 changes: 13 additions & 2 deletions docs/content/presentation/examples.ngdoc
View file
@@ -1,6 +1,17 @@
@ngdoc overview
@name Examples
@name Example
@priority 120
@description

# Some examples
# An example

<div style="border: 1px solid grey;">
<div ng-controller="exemple2Controller">
<div style="text-align: center; margin-top: 30px;">
<button type="button" class="btn btn-default navbar-btn" ng-click="toggleSortable()">
<span class="glyphicon glyphicon-random" aria-hidden="true">Toggle sort</span>
</button>
</div>
<dashboard id="components-simple-exemple2" data-width="auto" data-columns="4" data-columns-min-width="250"></dashboard>
</div>
</div>
8 changes: 4 additions & 4 deletions docs/content/presentation/more.ngdoc
View file
@@ -1,11 +1,11 @@
@ngdoc overview
@name what's next ?
@name Next steps
@priority 130
@description

# what is next
# Next steps

If you need a feature which is not describe here, you can submit a request on our <a href="https://github.com/fluanceit/angular-dashboard/issues">github issue tracker</a>.
If you need a feature which is not described here, you can submit a request on our <a href="https://github.com/fluanceit/angular-dashboard/issues">github issue tracker</a>.

Even if this project has only been contributed and build for one of our company project, we are very open to external contribution.<br/>
Feel free to get in touch with us, we would love to here from you !
Feel free to get in touch with us, we would love to hear from you !
1 change: 1 addition & 0 deletions docs/wiredep.js
View file
Expand Up @@ -10,6 +10,7 @@ gulp.task('docs:wiredep', function() {
.pipe(wiredep({
bowerJson: require('../bower.json'),
directory: 'bower_components',
devDependencies: true, // default: false
exclude: [
'/bootstrap-sass-official/',
'/bootstrap.js/',
Expand Down

0 comments on commit 4a2ea34

Please sign in to comment.