angular-ui/ui-grid

Support HTML in header

Open

#5,229 opened on Mar 15, 2016

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (5,395 stars) (2,496 forks)batch import
good first issueseverity: performancetype: enhancement

Description

Hi -

This is an enhancement request. A small change in the default header cell template would allow HTML formatted headers. Instead of the mustache, use ng-bind-html. ng-bind is also recommended over brackets and has better performance. I am successfully using the code/hack below.

    var h = $templateCache.get('ui-grid/uiGridHeaderCell');
    h = h.replace('>{{ col.displayName CUSTOM_FILTERS }}', ' ng-bind-html="col.displayName CUSTOM_FILTERS">');
    $templateCache.put('ui-grid/uiGridHeaderCell', h);

See it work in a plunk based on your custom filter demo: http://plnkr.co/edit/AN4Kk5?p=info

Small update: Also requires mod to uiGridMenuItem template to display HTML names in grid menu along these lines:

    var m = $templateCache.get('ui-grid/uiGridMenuItem');
    m = m.replace('{{ name }}', '<span ng-bind-html="name"></span>');
    $templateCache.put('ui-grid/uiGridMenuItem', m);

Of course instead of these hacks the template HTML should just be changed accordingly. Until that time this is an attempt to be drop-in upgrade compatible.

Contributor guide

Tech stack
javascripthtmlcss
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
AngularJS basicsui grid templatesng bind html usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
The issue requests changing the default header cell template (uiGridHeaderCell) and the grid menu template (uiGridMenuItem) to use ng bind html instead of mustache interpolation. The user provided a plunker demonstrating the hack. To implement, locate the template files in the ui grid source, modify them to replace `{{ col.displayName }}` with `ng bind html="col.displayName"` and ensure the $sce service is used appropriately. The maintainer should confirm if this change is acceptable and if there are any security implications with HTML in headers.