jupyterlab/jupyterlab

Add Data Attribute for Cell Tags

Open

#8,298 opened on Apr 28, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (13,454 stars) (2,937 forks)batch import
enhancementgood first issuehelp wantedpkg:cells

Description

Description

We should add a CSS data attribute to a cell that has the papermill "parameters" tag. Right now you'd have to dig into the model to get this information yourself. This information is useful because you might want to style the parameter cell differently. In fact, we may want to do that ourselves at some point.

This can be accomplished at the cell level, by listening for changes to cell metadata and applying or removing a CSS attribute based on the presence of that tag (e.g. setAttribute('data-parameter-cell', 'true')).

Contributor guide

Tech stack
typescriptcss
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
TypeScriptJupyterLab cell modelCSS attribute manipulation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the Cell widget in packages/cells/src/widget.ts, specifically the metadata handling at line 511. Investigate how tags are stored in cell metadata and how to observe changes. Then, implement a listener that sets or removes a 'data parameter cell' attribute on the cell DOM element based on the presence of the 'parameters' tag. Ensure the attribute is updated when metadata changes.
Add Data Attribute for Cell Tags · jupyterlab/jupyterlab#8298 | Good First Issue