javascripthtmlangularjsangularjs-directiveangularjs-compile

How to use the $compile service to include HTML data with AngularJS directives


I have a controller which is populating content to content areas using ng-repeat. The issue is that some of this content needs to come front template files and so needs to be compiled 'on the fly'. Right now I have this function dynamically adding content:

$scope.layouts = [

    { id: 'Dashboard', icon: 'dashboard', view: '/qph/views/Dashboard.php' },
    { id: 'Customers', icon: 'people', view: '/qph/views/users.php' },
    { id: 'Quotes', icon: 'format_list_bulleted', view: '/qph/views/Quotes.php' }

];

$scope.workspace = {};    

var getTemplate = function(id){

    var view = 'test.php';

    $timeout(function() { //added timeout

    if($templateCache.get(view) === undefined) {
            $templateRequest(view).then(function (data) {
                $scope.workspaces.forEach(function (v) {
                    if (v.id == id) v.content = $compile(data)($scope);
                });
            });

    } else {
        $scope.workspaces.forEach(function (v) {
            if (v.id == id) v.content = $compile($templateCache.get(view))($scope);
        });

    }
    }, 2000);
};

$scope.workspaces =
    [
        { id: 1, name: "Dashboard", icon: 'dashboard', active:true  }
    ];
getTemplate(1);

I have checked that the data variable has the html content as expected, but the compile is outputting the following:

{"0":{"jQuery331075208394539601512":{"$scope":"$SCOPE","$ngControllerController":{}}},"length":1}

Does anyone know why its not compiling the html content as expected?

Here is the template content for reference:

<div class="col-sm-6 col-sm-offset-3" ng-controller="UserController">
<div class="col-sm-6 col-sm-offset-3">
    <div class="well">
        <h3>Users</h3>
        <button class="btn btn-primary" style="margin-bottom: 10px" ng-click="user.getUsers()">Get Users!</button>
        <ul class="list-group" ng-if="user.users">
            <li class="list-group-item" ng-repeat="user in user.users">
                <h4>{{user.name}}</h4>
                <h5>{{user.email}}</h5>
            </li>
        </ul>
        <div class="alert alert-danger" ng-if="user.error">
            <strong>There was an error: </strong> {{user.error.error}}
            <br>Please go back and login again
        </div>
    </div>
</div>
</div>

Here is the tabs view that is to display the compiled content:

<ul class="nav nav-tabs workspace-tabs">
    <li class="nav-item" ng-repeat="space in workspaces">
        <a class="nav-link" data-toggle="tab" href="#workspace{{space.id}}" ng-class="(space.active == true ) ? 'active show': ''">
            <span class="hidden-sm-up"><i class="material-icons md-24">{{space.icon}}</i></span>
            <span class="hidden-xs-down">{{space.name}}</span>
            <button ng-click="workspace.remove($index)">x</button>
        </a>
    </li>
</ul>

<div class="tab-content workspace-content">
    <div ng-repeat="space in workspaces" id="workspace{{space.id}}" class="tab-pane fade in" ng-class="(space.active == true ) ? 'active show': ''">
        {{space.content}}
    </div>
</div>

Solution

  • The $compile service creates a jqLite object that needs to be added to the DOM with a jqLite or jQuery append() method. Using interpolation {{ }} will only render the stringified value of the jqLite object.

    <div class="tab-content workspace-content">
        <div ng-repeat="space in workspaces" id="workspace{{space.id}}" class="tab-pane fade in" ng-class="(space.active == true ) ? 'active show': ''">
            ̶{̶{̶s̶p̶a̶c̶e̶.̶c̶o̶n̶t̶e̶n̶t̶}̶}̶
            <compile html="space.html"></compile>
        </div>
    </div>
    

    Instead, use a custom directive to compile and append the HTML data to the DOM:

    app.directive("compile", function($compile) {
        return {
            link: postLink,
        };
        function postLink(scope, elem, attrs) {
            var rawHTML = scope.$eval(attrs.html)
            var linkFn = $compile(rawHTML);
            var $html = linkFn(scope);
            elem.append($html);
        }
    })
    

    For more information, see AngularJS Developer Guide - HTML Compiler.