Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(tab): add removable variation #2869

Draft
wants to merge 3 commits into
base: develop
Choose a base branch
from
Draft

feat(tab): add removable variation #2869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c0bc163
feat(tab): add removable variation
prudho Aug 2, 2023
282ee0c
fix(tab): linting issues
prudho Aug 2, 2023
64a586b
fix(tab): linting issue (again)
prudho Aug 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions src/definitions/modules/tab.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
$module = $(this),
$context,
$tabs,
$close = $module.find(selector.removeIcon),

cache = {},
firstLoad = true,
Expand All @@ -96,6 +97,13 @@
if (settings.auto) {
module.set.auto();
}

if (module.is.removable() && !module.has.removeIcon()) {
module.verbose('Adding close icon');
$close = $('<i />').addClass('remove icon');
$module.append($close);
}

module.bind.events();

if (settings.history && !initializedHistory) {
Expand Down Expand Up @@ -142,6 +150,7 @@
module.debug('Attaching tab activation events to element', $module);
$module
.on('click' + eventNamespace, module.event.click)
.on('click' + eventNamespace, selector.removeIcon, module.event.removeIcon.click)
;
}
},
Expand Down Expand Up @@ -224,6 +233,15 @@
module.debug('No tab specified');
}
},
removeIcon: {
click: function (event) {
var
tabPath = $(this).parent().data(metadata.tab)
;
module.removeTab(tabPath);
event.stopPropagation();
},
},
history: {
change: function (event) {
var
Expand Down Expand Up @@ -423,6 +441,36 @@
});
},

removeTab: function (tabPath) {
var
activeTab = module.determine.activeTab(),
$tab = module.get.tabElement(tabPath)
;
if (tabPath == $module.data(metadata.tab)) {
module.verbose('Call for tab removal', tabPath);
if (settings.onBeforeRemove.call(element, tabPath) === false) {
module.debug('onBeforeRemove returned false, cancelling tab removal', $tab);

return false;
}
var
nextTab = $module.nextAll(selector.enabled).length > 0
? $module.nextAll(selector.enabled).eq(0).data(metadata.tab)
: ($module.prevAll(selector.enabled).length > 0
? $module.prevAll(selector.enabled).eq(0).data(metadata.tab)
: module.get.initialPath())
;
$tab.removeClass(className.active).remove();
$module.removeClass(className.active).remove();
module.determineTabs();
settings.onRemove.call(element, tabPath);
if (activeTab == tabPath) {
module.debug('No active tab detected, setting tab active', nextTab);
module.changeTab(nextTab);
}
}
},

scrollTo: function ($element) {
var
scrollOffset = $element && $element.length > 0
Expand Down Expand Up @@ -609,6 +657,15 @@
? module.get.tabElement(tabName).length > 0
: false;
},
removable: function () {
return $module.hasClass(className.removable) || settings.removable;
},
},

has: {
removeIcon: function () {
return $close.length > 0;
},
},

get: {
Expand Down Expand Up @@ -916,6 +973,7 @@
loadOnce: false, // Whether tab data should only be loaded once when using remote content
cacheType: 'response', // Whether to cache exact response, or to html cache contents after scripts execute
ignoreFirstLoad: false, // don't load remote content on first load
removable: false,

apiSettings: false, // settings for api call
evaluateScripts: 'once', // whether inline scripts should be parsed (true/false/once). Once will not re-evaluate on cached content
Expand All @@ -926,6 +984,8 @@
onVisible: function (tabPath, parameterArray, historyEvent) {}, // called every time tab visible
onRequest: function (tabPath, parameterArray, historyEvent) {}, // called ever time a tab beings loading remote content
onBeforeChange: function (tabPath) {}, // called before a tab is about to be changed. Returning false will cancel the tab change
onBeforeRemove: function (tabPath) {}, // called before a tab is about to be removed. Returning false will cancel the tab removal
onRemove: function (tabPath) {}, // called when a tab is removed

templates: {
determineTitle: function (tabArray) {}, // returns page title for path
Expand Down Expand Up @@ -954,11 +1014,14 @@
className: {
loading: 'loading',
active: 'active',
removable: 'removable',
},

selector: {
tabs: '.ui.tab',
ui: '.ui',
enabled: ':not(.disabled)',
removeIcon: '> .remove.icon',
},

};
Expand Down
18 changes: 18 additions & 0 deletions src/definitions/modules/tab.less
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,24 @@
display: none;
}

/*******************************
Types
*******************************/

/* --------------------
Closable
--------------------- */

& when (@variationTabRemove) {
.ui.menu .item > .remove.icon {
cursor: pointer;
font-size: @removeIconSize;
padding: @removeIconPadding;
opacity: @removeIconOpacity;
z-index: @removeIconZIndex;
}
}

/*******************************
States
*******************************/
Expand Down
1 change: 1 addition & 0 deletions src/themes/default/globals/variation.variables
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -714,6 +714,7 @@

/* Tab */
@variationTabLoading: true;
@variationTabRemove: true;

/* Toast */
@variationToastInverted: true;
Expand Down
8 changes: 8 additions & 0 deletions src/themes/default/modules/tab.variables
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,11 @@

@loaderDistanceFromTop: 50%;
@loaderSize: 2.5em;

/* Removable */

@removeIconSize: @relative12px;
@removeIconPosition: 2em;
@removeIconOpacity: 0.6;
@removeIconPadding: 0 0 0 1em;
@removeIconZIndex: 3;