kanbanworkflowstimelinescrumrubyroadmapproject-planningproject-managementopenprojectangularissue-trackerifcgantt-chartganttbug-trackerboardsbcf
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
57 lines
1.6 KiB
57 lines
1.6 KiB
9 years ago
|
Additional hints
|
||
|
|
================
|
||
|
|
|
||
|
|
## Passing information and configuration from Rails to Angular
|
||
|
|
|
||
|
|
There are three ways of passing information from Rails to `angular`:
|
||
|
|
|
||
|
|
1. Using tag attributes written directly to the DOM by the rendering process of Rails:
|
||
|
|
|
||
|
|
```html
|
||
|
|
// @see ./app/views/layouts/angular.html.erb
|
||
|
|
<body class="<%= body_css_classes %>" ng-app="openproject" data-relative_url_root="<%= root_path %>" ng-init="projectIdentifier = '<%= (@project.identifier rescue '') %>'">
|
||
|
|
<!-- [..] -->
|
||
|
|
</body>
|
||
|
|
```
|
||
|
|
|
||
|
|
2. Using the `gon` gem
|
||
|
|
|
||
|
|
This is included by all layouts in `<head>`:
|
||
|
|
|
||
|
|
```
|
||
|
|
<%= include_gon %>
|
||
|
|
```
|
||
|
|
|
||
|
|
`gon` will provide arbitrary settings from Rails to all JavaScript functionality, including `angular`. In an `angular` context a `ConfigurationService` is provided.
|
||
|
|
|
||
|
|
3. From the APIv3
|
||
|
|
|
||
|
|
APIv3 introduces a settings endpoint which can be used to query settings from the API directly. This is useful for querying user specific settings and guarded information.
|
||
|
|
|
||
|
|
The only place this is currently used is within the `ConfigurationService`, which provides an `api`, which can be used in this fashion:
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
// angular injected
|
||
|
|
|
||
|
|
function(ConfigurationService) {
|
||
|
|
ConfigurationService.api().then(function(settings) {
|
||
|
|
console.log(settings);
|
||
|
|
})
|
||
|
|
}
|
||
|
|
|
||
|
|
// from the outside
|
||
|
|
angular
|
||
|
|
.element('body')
|
||
|
|
.injector()
|
||
|
|
.invoke([
|
||
|
|
'ConfigurationService',
|
||
|
|
function(service) {
|
||
|
|
service.api().then(function(settings) {
|
||
|
|
console.log(settings);
|
||
|
|
})
|
||
|
|
}
|
||
|
|
])
|
||
|
|
```
|
||
|
|
|
||
|
|
Calls to the API are cached between page reloads. It would be advisable to cache them longer in the future, as the data rarely updates.
|