Material View Support for Stock NodeBB

[phenomlab]

@DownPW You’re missing a hook

I’ve added this

$(window).on('action:topics.loaded', function (data) {
    material();
});

Works now !

[phenomlab]

@DownPW said in Material View Support foir Stock NodeBB:

I would also like to change the button which is not suitable for a vertical display

You could rotate it?

.material-threads-wrapper {
    display: flex;
    left: 5px !important;
    position: relative !important;
    transform: rotate(45deg);
    margin-left: -2px;
    margin-top: 5px;
}

[cagatay]

@DownPW could you pls share updated and enclosed codes for css and js?

[DownPW]

@cagatay The code is not mature yet. There is still work to be done and phenomlab will have to validate it because I am not a developer

@phenomlab said in Material View Support foir Stock NodeBB:

You could rotate it?

yep sure it’s better
but I was thinking of a 2-state radio button like the form-switch because I believe Bootstrap offers it if I don’t say bullsh*t.

[phenomlab]

@DownPW said in Material View Support foir Stock NodeBB:

but I was thinking of a 2-state radio button like the form-switch because I believe Bootstrap offers it if I don’t say bullsh*t.

Something like this?

https://jsfiddle.net/milanandfriends/p9AaY/

[DownPW]

yes maybe, I had thought about that but just one button not two but why not :

https://getbootstrap.com/docs/5.0/forms/checks-radios/

I’m not closed off I’m trying to see what could be better.

[DownPW]

see this @phenomlab

the element is perfect regardless of the mode engaged but a refresh does not replace it correctly.
A missing hook?

[phenomlab]

@DownPW No. More likely a CSS class is not being applied on load.

[DownPW]

hmm that doesn’t help me much

[phenomlab]

@DownPW Add this to your existing css class of

.page-topic .topic .posts.timeline [component="topic/event"].timeline-event, .page-topic .topic .posts.timeline [component="topic/necro-post"].timeline-event

    margin-left: 52px;

So you land up with

.page-topic .topic .posts.timeline [component="topic/event"].timeline-event, .page-topic .topic .posts.timeline [component="topic/necro-post"].timeline-event {
    margin-bottom: 10px;
    margin-left: 52px;
}

That will fix it.

[DownPW]

no it’s worse

Maybe, the best would be to add a .material class but I can’t do it at the moment

[phenomlab]

@DownPW I remember this same issue now when I came across it whilst writing the threaded function. The problem here is that [component="topic/necro-post"] actually isn’t present in the DOM on page load, but added afterwards. This is why once the page has loaded, you can target the element with the toggle switch because it is in the DOM at the time. Because the this specific element is loaded afterwards, you cannot target it if it doesn’t exist.

This effectively means you cannot add a class to an element that is not there. To work around this, you’d either have to wait for the page to load, add the necro element, then target it.

Or, use the CSS I provided, and then “counter” it using other CSS when the class is removed. This is what I do in thwe threaded function.

Raised this as an issue here

https://community.nodebb.org/topic/17590/necro-function-dom-changes

EDIT - should work now

I’ve added a loop in your material function that looks specifically for the necro post

$('[component="topic/necro-post"]').each(function () {
     // Add the 'material' class to matching elements
     if ($(this).hasClass('timeline-event')) {
     $(this).addClass('material');
     }
 });

And also (on the advice of Baris) added a new hook as below

$(window).on('action:topic.loaded', function (data) {
    material();
});

There are two separate hooks that look very much the same, but do different things (one has an “s” at the end, whilst the other doesn’t - “action:topic.loaded” and “action:topic%(#fa0000)[s].loaded”

Now it works as intended

[DownPW]

ohh yes better

I undersxtand for adding .each(function () for [component=“topic/necro-post”]

I have read the thread on nodeBB communauty. On the other hand, I don’t really understand the difference for the hook in topic and topicS

[phenomlab]

@DownPW I think the difference is that the topic hook is for single, and topics for a selection. Makes sense, but not very well explained in the documentation!

[DownPW]

Thanks for explain. Make sense, indeed but it’s not easy to know without Baris help

---

Still with the idea of improving the code, I’m going to focus now on making the selection button appear on Smartphone.

Indeed, currently, it does not appear because it seems that on Smartphone another component is used

[DownPW]

I test this :

// ------------------------------------------
// material View Mode
// ------------------------------------------

function material() {
    $(document).ready(function () {
        var $buttonContainer = null;

        // Check if the screen width is 460px or more
        if ($(window).width() >= 991) {
            // Check if the custom thread view button already exists in the right sidebar
            $buttonContainer = $('[component="sidebar/right"]');
        } if ($(window).width() <= 991) {
            // Check if the custom thread view button already exists in the bottom bar
            $buttonContainer = $('[component="bottombar"]');

        }

[phenomlab]

@DownPW yes, the same methodology is used for the theme switcher in NodeBB v2.x

[DownPW]

ohh yes, don’t see that to be honest.

Button appear but hard to position it correctly for all resolution.
The button moves according to the resolution. it is not fixed

[phenomlab]

@DownPW if you use apend then it should reflect the div it is inserted into.

The version of the theme switcher from the NodeBB v2 series used the same mechanism, and that code is still listed in this forum. It would be a good idea to review that code for inspiration as the placement for the switcher drop down was set depending on screen estate.

[phenomlab]

@DownPW this should provide the functionality you are looking for

// ------------------------------------------
// material View Mode
// ------------------------------------------
function material() {
    $(document).ready(function () {
            // Create the button for custom thread view mode with custom IDs
            if ($('#materialThreadViewButton').length === 0) {
                var threadViewButton = $('<div class="material-threads-wrapper"><form class="form"><div class="form-check form-switch form-switch-sm material-threads-wrapper"> \
                    <input class="form-check-input" id="materialThreadViewButton" type="checkbox" data-field="materialThreadView"> \
                    <label class=" d-none d-md-inline fw-semibold" for="materialThreadViewButton"></label> \
                </div></form></div>');
                
                        // Check if the screen width is 460px or more
        if ($(window).width() >= 991) {
            // Check if the custom thread view button already exists in the right sidebar
            var buttonContainer = $('[component="sidebar/right"]');
            // Append the button to the selected container
            buttonContainer.append(threadViewButton);
        } 
        if ($(window).width() <= 991) {
            // Check if the custom thread view button already exists in the bottom bar
            //$buttonContainer = $('.bottombar-nav.p-2.text-dark.bg-light.d-flex.justify-content-between.align-items-center.w-100');
            if ($("#logged-in-menu").length > 0) {
            var buttonContainer = $('.bottombar-nav ul#logged-in-menu');
            }
            else {
                var buttonContainer = $('.bottombar-nav ul#logged-out-menu'); 
            }
                        // Prepend the button to the selected container
            buttonContainer.prepend(threadViewButton);
        }
            }
            // Check if there's a stored state for the checkbox and update it
            var storedState = localStorage.getItem('materialThreadViewState');
            console.log("Stored State is " + storedState);
            if (storedState === 'true') {
                $('#materialThreadViewButton').prop('checked', true);
            }
            
            // Toggle the class 'material' on or off when the checkbox changes state
            $('#materialThreadViewButton').on('change', function () {
                var isChecked = $(this).is(':checked');
                var theTooltip = isChecked ? "Material View Off" : "Material View On"; // Update tooltip message
                
                // Toggle CSS rules when the button is turned on or off
                if (isChecked) {
                    console.log('Material Thread view is active.');
                    // Apply your CSS rules here
                    $('[component="category/topic"]').addClass('material'); 
                    $('li[component="category/topic"]').addClass('material'); 
                    $('[component="categories/category"]').addClass('material');
                    
                    $('.posts-container').addClass('material')
                    $('ul[component="topic"]').addClass('material')
                    $('.post-container').addClass('material')
                    $('.timeline-event').addClass('material')
                    $('[component="post/footer"]').addClass('material')
                    $('li.pt-4.deleted').addClass('material') 
                    
                    $('.page-topic .topic .posts.timeline .timeline-event > div:first-of-type, .page-topic .topic .posts.timeline > [component="post/placeholder"] > div:first-of-type, .page-topic .topic .posts.timeline > [component=post] > div:first-of-type').addClass('material');

                    $('[component="post"]').each(function () {
                        // Add the 'material' class to matching elements
                        if ($(this).hasClass('pt-4') || $(this).hasClass('self-post')) {
                            $(this).addClass('material');
                            $('[component="sidebar/right"]').addClass('material');
                        }
                    });
                    $('[component="topic/necro-post"]').each(function () {
                        // Add the 'material' class to matching elements
                        if ($(this).hasClass('timeline-event')) {
                            $(this).addClass('material');
                        }
                    });

                } else {
                    console.log('Material Thread view is inactive.');
                    // Remove the CSS rules here
                    $('[component="category/topic"]').removeClass('material');
                    $('li[component="category/topic"]').removeClass('material');
                    $('[component="categories/category"]').removeClass('material');
                    
                    $('[component="post"]').removeClass('material');
                    $('ul[component="topic"]').removeClass('material');
                    $('.posts-container').removeClass('material')
                    $('ul[component="topic"]').removeClass('material')
                    $('.post-container').removeClass('material')
                    $('.timeline-event').removeClass('material')
                    $('[component="post/footer"]').removeClass('material');
                    $('li.pt-4.deleted').removeClass('material'); 
                   
                    $('.page-topic .topic .posts.timeline .timeline-event > div:first-of-type, .page-topic .topic .posts.timeline > [component="post/placeholder"] > div:first-of-type, .page-topic .topic .posts.timeline > [component=post] > div:first-of-type').removeClass('material'); 

                    $('[component="sidebar/right"]').removeClass('material');
                    
                }
                
                // Store the checkbox state in localStorage
                localStorage.setItem('materialThreadViewState', isChecked);
                
                // Update the tooltip title
                $(this).attr('data-original-title', theTooltip).tooltip('dispose').tooltip({
                    placement: 'bottom',
                    title: theTooltip,
                    trigger: 'hover'
                });
            });

            // Check for changes in the checkbox state when the page loads
            $('#materialThreadViewButton').trigger('change');
        
    });
}

Result

I ddjusted some of your CSS - added this block

#logged-out-menu .material-threads-wrapper {
    top: 5px;
    position: relative;
}

Also removed this block

#materialThreadViewButton {
}

Not needed

There are are two checks - one tests the screen estate and positions the menu item depending on size, and the other will see if the user is logged in or not, and if they are, it uses ul#menu-logged-in else it uses ul#menu-logged-out

But only for the mobile view because .bottom-bar is based on both logged in and logged out sessions

Enjoy