Allow to star and unstar stored segment #23771

tzi · 2025-11-12T01:55:06Z

Description

New “Star” Feature: each segment can be "starred" by clicking on a star icon.
Starred segments are highlighted at the top of the list.

What happen when a segment star is clicked :

Move the segment immediately at the top of the list
The Star icon is filled in
A API called is made to store this change

Screenshots

before / after

before	after

tooltips

tooltip unstarred	tooltip starred

Animation

star	unstar	error

Checklist

[NA] I have understood, reviewed, and tested all AI outputs before use
[NA] All AI instructions respect security, IP, and privacy rules

Review

tzi · 2025-11-17T17:42:07Z

...ntEditor/tests/UI/expected-screenshots/SegmentSelectorEditorTest_2_segment_editor_update.png

ℹ️ The new tests changed the visible focused element on this screenshot.

tzi · 2025-11-17T17:42:47Z

...SegmentEditor/tests/UI/expected-screenshots/SegmentSelectorEditorTest_1_selector_starred.png

ℹ️ The starred segment comes at the top of the list

tzi · 2025-11-17T23:07:20Z

plugins/SegmentEditor/javascripts/Segmentation.js

+            self.target.find('[title]').each(function () {
+              addTooltip(this, this.getAttribute('title'));
+            });


ℹ️ Fix tooltip for all actions in the SegmentList

tzi · 2025-11-17T23:08:23Z

plugins/SegmentEditor/stylesheets/segmentation.less

+    display: flex;
+    flex-direction: column;


ℹ️ Use flexbox to be able to reorder starred segment easily.

tzi · 2025-11-17T23:08:44Z

plugins/SegmentEditor/stylesheets/segmentation.less

+.segmentationContainer .submenu ul li[data-idsegment=""] {
+    order: 0;
+}


ℹ️ First line is always "All visitors"

plugins/SegmentEditor/javascripts/Segmentation.js

plugins/SegmentEditor/API.php

sgiehl

Left some comments. Besides those I'm wondering if the highlight effect after staring/unstaring a segment id expected. The segment remains highlighted even after hover of other segments 🤔

core/Updates/5.6.0-b2.php

core/Version.php

plugins/SegmentEditor/javascripts/Segmentation.js

plugins/SegmentEditor/API.php

plugins/SegmentEditor/javascripts/Segmentation.js

sgiehl · 2025-11-28T12:32:39Z

core/Updates/5.7.0-b1.php

+    {
+        return [
+            $this->migration->db->addColumns('segment', [
+                'starred' => 'TINYINT(1) NOT NULL DEFAULT 0',


Another thing came to my mind after reading the requirements again. If that hasn't changed again the starring should be handled by website, but currently that happens by segment. This might need some clarification.

I do not understand this comment.
I understood the requirements that we should star a segment per Matomo instance and not per user, so a starred segment is visible by every users. That’s why we added a "starred by …" label.
Do you think we should store the segment per website entity?

mattab · 2025-11-28T21:21:35Z

UPDATED COMMENT

Here is a clarification. Considering that segments can be created across all websites by a super user, we can't let people remove them from Starred on one website which would affect other websites where this segment exists. So we need to treat these global segments differently when it comes to starring.

In addition:

View users can only add to Starred or remove from Starred for the segments they created themselves.
For any segment created by someone else, only Write, Admin, or Super Users can add/remove from Starred.
Only Super Users can edit segments that apply across all sites.

Below are the proposed tooltips that reflect these rules:

1. Global segment

For non super users (star icon disabled)

This is a global segment created by a super user. Only super users can edit or star global segments.

For super users (star icon enabled)

This is a global segment. Adding to Starred or removing from Starred will apply across all websites.

2. Site-specific segment

For users without permission to star (e.g. View user viewing someone else's segment)

You can only add to Starred the segments you created yourself.

For users with permission (Write/Admin/Super User, or View user starring their own segment)

Add to Starred segments for this website.

sgiehl · 2025-11-30T16:03:38Z

@mattab Is there a specific reason why this isn't a user specific action? Personally I think allowing every user to star the segments they need, rather than having it global or site specific might bring much more value to the customers. And storing that per user instead of together with the segment wouldn't be that much more effort - compared to implementing the special handling for global segments.

mattab · 2025-11-30T21:56:58Z

The main reason is to

Keep it simple and consistent between team members and although it's limiting in some way it's also liberating to be consistent
try and understand what is really important to this website so that later we can use that information to better generate Insights that are relevant to these segments. (FYI also same eventually for starred segments and starred pages then I think they should be by website. The only different one are reports which are really different for people and for that I would call it differently like pinned reports and have it per user but maybe eventually let them pin across users as well)
It's less effort and I rather not change the scope now for this.

tzi · 2025-12-02T15:49:15Z

plugins/SegmentEditor/javascripts/Segmentation.js

+                  comparedSegments.indexOf(decodeURIComponent(definition)) !== -1
+                );
+                $segment.toggleClass('comparedSegment', isCompared);
+                $segment.find('.compareSegment').attr('data-state', isCompared ? 'active' : '');


ℹ️ Handle an active state on comparison segment button

tzi · 2025-12-02T15:50:24Z

plugins/SegmentEditor/javascripts/Segmentation.js

-                $(this).addClass('no-click');
-                $(this).parent().attr('title', _pk_translate('General_MaximumNumberOfSegmentsComparedIs', [limit]));
+                $compareButton.attr('data-state','disabled');
+                addTooltip($compareButton, _pk_translate('General_MaximumNumberOfSegmentsComparedIs', [limit]));


ℹ️ Add a disabled state for the compare button
ℹ️ The tooltip was on the libut it should have been on the .compareSegment button

…e edit icon

tzi added the Pull Request WIP Indicates the current pull request is still work in progress and not ready yet for a review. label Nov 12, 2025

tzi changed the title ~~Allow to start/unstar stored segment~~ Allow to star and unstar stored segment Nov 14, 2025

tzi force-pushed the ux-326 branch 10 times, most recently from 24a8707 to cb064c5 Compare November 17, 2025 17:41

tzi commented Nov 17, 2025

View reviewed changes

tzi force-pushed the ux-326 branch from 75e8f2c to 92a15a7 Compare November 17, 2025 23:05

tzi commented Nov 17, 2025

View reviewed changes

tzi force-pushed the ux-326 branch 2 times, most recently from d004753 to 5c02c19 Compare November 17, 2025 23:55

tzi marked this pull request as ready for review November 18, 2025 01:03

tzi requested a review from a team November 18, 2025 01:03

michalkleiner requested changes Nov 18, 2025

View reviewed changes

tzi force-pushed the ux-326 branch from be9a5f8 to 891fb4d Compare November 18, 2025 10:41

tzi force-pushed the ux-326 branch 2 times, most recently from 7134cf8 to 581d2c2 Compare November 25, 2025 06:54

sgiehl requested changes Nov 27, 2025

View reviewed changes

sgiehl reviewed Nov 28, 2025

View reviewed changes

tzi force-pushed the ux-326 branch 2 times, most recently from 3d259c0 to 094a34f Compare November 28, 2025 16:10

tzi force-pushed the ux-326 branch 2 times, most recently from b6209bd to dc0d932 Compare December 2, 2025 10:08

sgiehl removed the request for review from michalkleiner December 2, 2025 15:08

tzi commented Dec 2, 2025

View reviewed changes

tzi added 15 commits December 3, 2025 17:19

Allow to start/unstar stored segment

697ff07

Add and Update tests

5b291ea

Add tooltip on stars and fix existing tooltips

efc560b

Migrate array notation, feedback from @michalkleiner

523d929

Handle API error and add micro-animation

7209bbd

Update the tooltip to precise who star a segment

ee30feb

Feedback from @michalkleiner

31bee79

Fix segement search

be2d1fc

Fix segmentation-list scroll

95c2822

improve anonymous segment list

f747d5a

Feedbacks from @sgiehl

39fb991

Handle star segment button in disable mode, for anonymous user, updat…

e633849

…e edit icon

Make edit and compare buttons accessible

6689609

Handle all tooltip cases, fix edit and compare behaviour and tooltip

aad480f

Update UI screenshots

fbd7944

tzi force-pushed the ux-326 branch from 65ba22d to fbd7944 Compare December 3, 2025 16:20

Uh oh!

Allow to star and unstar stored segment #23771

Are you sure you want to change the base?

Allow to star and unstar stored segment #23771

Uh oh!

Conversation

tzi commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Screenshots

before / after

tooltips

Animation

Checklist

Review

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sgiehl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mattab commented Nov 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

1. Global segment

For non super users (star icon disabled)

For super users (star icon enabled)

2. Site-specific segment

For users without permission to star (e.g. View user viewing someone else's segment)

For users with permission (Write/Admin/Super User, or View user starring their own segment)

Uh oh!

sgiehl commented Nov 30, 2025

Uh oh!

mattab commented Nov 30, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

6 participants

tzi commented Nov 12, 2025 •

edited

Loading

mattab commented Nov 28, 2025 •

edited

Loading