angular-ui/ui-grid

[selection] - event rowSelectionChanged - pass GridCol along with GridRow

Open

#4,534 opened on Oct 16, 2015

View on GitHub
 (4 comments) (1 reaction) (0 assignees)JavaScript (5,395 stars) (2,496 forks)batch import
breakinghelp wantedtype: enhancement

Description

currently event rowSelectionChanged has the following signature:

on.rowSelectionChanged($scope, function (row, event) { ... })

I have a use case when I'd also find useful information about column being clicked.

Detailed scenario: Clicking on the row has an event associated (ex: redirects to another state). However, the very last column of each row is a custom column that allows deleting of that row. Currently clicking on the delete button in the given row will also trigger rowSelectionChanged event, which is not desired just for that column. Given that I had information about GridCol in this event, I could write something like:

on.rowSelectionChanged($scope, function(row, col, event) {
    if (col.name != 'delete') {
        $state.go('superState');
    }
});

This would be a breaking change since it would change the signature of the event. If I'm given a green light, I'll submit a PR.

Contributor guide

Tech stack
javascriptangular
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.
clear
Prerequisites
JavaScriptAngularJS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Locate the definition of the 'rowSelectionChanged' event in the ui grid source code, likely in the selection feature module (e.g., src/features/selection/). Modify the event emission to include the GridCol parameter as the second argument. Update the event documentation and ensure backward compatibility if possible. Check and update existing tests accordingly.