Skip to content

Allow editing the HTML for the remove_button plugin #1050

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

Open
neilvcarvalho wants to merge 3 commits into
base: master
Choose a base branch
from
+18 −13
Open

Allow editing the HTML for the remove_button plugin #1050

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
c4921ad
Remove unused `append` option
neilvcarvalho Jun 9, 2026
e35e177
Allow editing the HTML for the remove_button plugin
neilvcarvalho Jun 9, 2026
43941da
Generate an HTMLElement instead of a string
neilvcarvalho Jun 9, 2026
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
27 changes: 15 additions & 12 deletions src/plugins/remove_button/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,28 @@ import { TomOption, TomItem } from '../../types/index.ts';
import { RBOptions } from './types.ts';

export default function(this:TomSelect, userOptions:RBOptions) {
const self = this;

const options = Object.assign({
label : '×',
title : 'Remove',
className : 'remove',
append : true
tabindex : -1,
role : 'button',
html : (data:RBOptions) => {
const el = document.createElement('div');

el.className = data.className || '';
el.title = data.title || '';
el.setAttribute('role', data.role || 'button');
el.tabIndex = data.tabindex ?? -1;
el.textContent = data.label || '';

return el;
}
}, userOptions);


//options.className = 'remove-single';
var self = this;

// override the render method to add remove button to each item
if( !options.append ){
return;
}

var html = '<a href="javascript:void(0)" class="' + options.className + '" tabindex="-1" title="' + escape_html(options.title) + '">' + options.label + '</a>';

self.hook('after','setupTemplates',() => {

var orig_render_item = self.settings.render.item;
Expand All @@ -47,7 +50,7 @@ export default function(this:TomSelect, userOptions:RBOptions) {

var item = getDom(orig_render_item.call(self, data, escape)) as TomItem;

var close_button = getDom(html);
var close_button = getDom(options.html(options));
item.appendChild(close_button);

addEvent(close_button,'mousedown',(evt) => {
Expand Down
4 changes: 3 additions & 1 deletion src/plugins/remove_button/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,7 @@ export type RBOptions = {
label ?: string,
title ?: string,
className ?: string,
append ?: boolean
tabindex ?: number,
role ?: string,
html ?: (data: RBOptions) => string,
};