bull-board icon indicating copy to clipboard operation
bull-board copied to clipboard

Feature request: Customize header image / text

Open jamesdwilson opened this issue 2 years ago • 11 comments

It would be nice to be able to pass in alternative text or CSS class or image for the header.

jamesdwilson avatar Jul 14 '22 23:07 jamesdwilson

It would be nice, but it is not so simple.

Think that you will need to change the favicon as well. How do you think that the best option will be? Allowing users to pass castomization object with logo url?

felixmosh avatar Jul 15 '22 00:07 felixmosh

Let me specify an override template ejs file?

On Thu, Jul 14, 2022 at 7:36 PM Felix Mosheev @.***> wrote:

It wound be nice, but it is not so simple.

Think that you will meed to change the favicon as well. How do you think that the best option will be? Allowing users to pass castomization object with logo url?

— Reply to this email directly, view it on GitHub https://github.com/felixmosh/bull-board/issues/431#issuecomment-1185054367, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAHGIHCWYYPDXRNME2X2CSTVUCXBTANCNFSM53T2DL6Q . You are receiving this because you authored the thread.Message ID: @.***>

-- Thank you,

James D. Wilson https://jameswilson.name

jamesdwilson avatar Jul 15 '22 04:07 jamesdwilson

It can be possible :] I have a list of features that I need to add before this one, If you really want this, I'll more than happy to review a PR :]

felixmosh avatar Jul 15 '22 07:07 felixmosh

Just came here to say that I agree, this would be a great feature—and to share why it would be useful in my case.

My use case would be: to add some way to visually distinguish between different instances of bull-board.

For example, we have separate deployments of bullmq for our development/staging/production environments, and we have bull-board running on each, to view/interact with the different queues in each environment. I often find that I have multiple browser tabs open with bull-board in different environments, and it can be quite easy to mistake one environment's dashboard for another. So having a way to make one say "Production" somewhere at the top vs "Development"—possibly using different colors even—would make a meaningful difference.

davejhilton avatar Jul 15 '22 20:07 davejhilton

@davejhilton thank you for sharing your use-case, I think that allowing to pass custom ejs file will expose too much of the internals.

Each minor / patch version you will need to update your ejs file (asset hashes)... Maybe, it is better to allow to pass env config, which if exists the board render it (with some style), WDYT?

felixmosh avatar Jul 17 '22 07:07 felixmosh

BTW, you can modify the final html as you wish by providing a custom ServerAdapter, for example, for Express adapter, You can copy the one that is provided, and change the viewHandler here https://github.com/felixmosh/bull-board/blob/e52e83dc070b70ff8f95908808278075325c5964/packages/express/src/ExpressAdapter.ts#L89-L91

felixmosh avatar Jul 17 '22 07:07 felixmosh

Thanks for that last note Felix that might fit my use case.

On Sun, Jul 17, 2022 at 2:17 AM Felix Mosheev @.***> wrote:

BTW, you can modify the final html as you wish by providing a custom ServerAdapter, for example, for Express adapter, You can copy the one that is provided, and change the viewHandler here

https://github.com/felixmosh/bull-board/blob/e52e83dc070b70ff8f95908808278075325c5964/packages/express/src/ExpressAdapter.ts#L89-L91

— Reply to this email directly, view it on GitHub https://github.com/felixmosh/bull-board/issues/431#issuecomment-1186427306, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAHGIHBURLVYU56K33V5OHTVUOXQNANCNFSM53T2DL6Q . You are receiving this because you authored the thread.Message ID: @.***>

-- Thank you,

James D. Wilson https://jameswilson.name

jamesdwilson avatar Jul 17 '22 18:07 jamesdwilson

BTW, you can modify the final html as you wish by providing a custom ServerAdapter, for example, for Express adapter, You can copy the one that is provided, and change the viewHandler

Oh, I hadn't thought of that! This should actually work perfectly for the (minimal) changes I need. Thanks!

davejhilton avatar Jul 19 '22 14:07 davejhilton

I'm closing this issue since I don't think that it is a good practice to expose internals

felixmosh avatar Jul 19 '22 15:07 felixmosh

Vote to leave open and allow passing in custom title, CSS class of logo, image url.

jamesdwilson avatar Jul 19 '22 16:07 jamesdwilson

Lets vote for it :]

felixmosh avatar Jul 19 '22 16:07 felixmosh

Closing this since there is no demand for this.

felixmosh avatar Nov 08 '22 18:11 felixmosh