Wiederverwendung der Discourse-Hamburger-Funktionalität

[sarahann (Sarah)]

Hello Discourse Team!

I am using the discourse CLI Discourse Theme CLI (console app to help you build themes) and the plugin API A new versioned API for client side plugins to help me create my theme.

I have added a custom header in the header.html file. On mobile, I was hoping to create a hamburger menu that functions like discourse’s hamburger

But has completely different menu contents.

I could create the hamburger and menu with my knowledge of css/html/js. But I was hoping for a way to use the functionality that discourse has already implemented (opening, closing, etc…).

Any suggestions on how to achieve this?

• I thought maybe I would be able to extend the widget for the current navigation, change the settings, then attach it to the html I have written for my nav. But the connectors seemed to be predefined, and I wasnt sure how to connect my widget to my html. This might not be the right direction at all either…

[sarahann (Sarah)]

Okay, so I think I have a better understanding on what I am trying to do.

I would like to create a connector where I can connect to one of the elements that I have added to the page.

I’m guessing this isn’t possible???

The plugin API (https://github.com/discourse/discourse/blob/master/app/assets/javascripts/discourse/lib/plugin-api.js.es6#L11) has api.registerConnectorClass but I cannot seem to figure out how to connect this to my custom element.

[simon]

@sarahann

On mobile, I was hoping to create a hamburger menu that functions like discourse’s hamburger

The Brand Header might give you some ideas about how to approach this. You can find its code here: GitHub - discourse/discourse-brand-header: Brand header theme component for Discourse. It only displays a hamburger menu in mobile mode. You can get the mobile view on a desktop by appending
?mobile_view=1 to your forum’s URL.

[awesomerobot (Kris)]

This is slightly rough but should get you 99% of the way there when it comes to having an additional menu item with a dropdown panel. Calling this one a pizza menu . Add this to your header.html file.

<script type="text/discourse-plugin" version="0.8">
        
api.createWidget('pizza-menu', {
  tagName: 'div.pizza-panel',

  panelContents() {
    return "hello world";
  },

  html() {
    return this.attach('menu-panel', {
      contents: () => this.panelContents()
    });
  },

  clickOutside() {
    this.sendWidgetAction('togglePizza');
  }
});
    
api.decorateWidget('header-icons:after', function(helper) {
  const headerState = helper.widget.parentWidget.state;
  let contents = [];
    contents.push(helper.attach('header-dropdown', {
      title: 'pizza-menu',
      icon: 'cutlery',
      active: headerState.pizzaVisible,
      iconId: 'toggle-pizza-menu',
      action: 'togglePizza',
    }));
    if (headerState.pizzaVisible) {
            contents.push(helper.attach('pizza-menu'));
    }
    return contents;
});

api.attachWidgetAction('header', 'togglePizza', function() {
  this.state.pizzaVisible = !this.state.pizzaVisible;
});

</script>
        

[sarahann (Sarah)]

Yes! This is very close!

My only concern was the connect part:

@awesomerobot

api.attachWidgetAction(‘header’, ‘togglePizza’, function() {
this.state.pizzaVisible = !this.state.pizzaVisible;
});

What if I wanted to add the pizza menu to a custom HTML element (defined in common/head_tag.html)?

[awesomerobot (Kris)]

Ah ok in that case you’re looking at something more like what @simon mentioned in the brand header theme component, I was attaching the action to the existing header widget… the brand header adds it to a new one. The new widget here w/ toggleHamburger:

 api.createWidget('brand-header', {
    tagName: 'header.b-header.clearfix',
    buildKey: () => `header`,
  
    defaultState() {
      let states =  {
        hamburgerVisible: false
      };
  
      return states;
    },
  
    toggleHamburger() {
      this.state.hamburgerVisible = !this.state.hamburgerVisible;
    },

and then the action is added to an HTML element in another widget here

api.createWidget('brand-header-icons', {
    tagName: 'ul.icons.clearfix',
  
    buildAttributes() {
      return { role: 'navigation' };
    },
  
    html(attrs) {
      const hamburger = this.attach('header-dropdown', {
                              title: 'hamburger_brand_menu',
                              icon: 'bars',
                              iconId: 'toggle-hamburger-brand-menu',
                              active: attrs.hamburgerVisible,
                              action: 'toggleHamburger'
                            });
      const icons = [hamburger];
      return icons;
    },
  });

[kimardenmiller (Kim Miller)]

@awesomerobot

Calling this one a pizza menu .

Thank you for this code. Can you point me in the right direction on filling out the panelContents? I see some indication, but not sure how it all links together.

[Queth (Q)]

Hallo! Ich weiß, dass dies ein altes Thema ist, aber es kommt dem, was ich suche/versuche zu tun, fast sehr nahe. Deshalb poste ich hier (anstatt ein neues Thema zu erstellen). Bitte beachte, dass ich kein Entwickler bin und nicht weiß, wie die Plugins funktionieren oder wie man JavaScript schreibt. Aber ich weiß, wie man Code kopiert und einfügt

Was ich versuchen möchte, ist, eine Anmeldung für einen Chatroom in ein Dropdown-Menü einzubinden. Ich möchte also ein “Chat”-Symbol haben, und im Dropdown-Menü soll ein Eingabefeld und ein Absende-Button sowie ein Hilfetext/Link zur Hilfeseite enthalten sein.

Kann ich deinen Code dann anpassen, indem ich statt des ‘Besteck’-Symbols ein ‘Chat’-Symbol verwende? Wie mache ich das?
Und zweitens: Wie kann ich HTML-Code anstelle der ‘Hello World’-Anweisung einfügen? (Im Grunde: Wie gibt man dort HTML ein?)

Vielen Dank im Voraus!

[ngets]

In Bezug auf Queths Beitrag: Ist es möglich, direkt vor dem FAQ-Eintrag im Dropdown-Menü einen zusätzlichen Link einzufügen?

Diese Komponente könnte funktionieren. Man muss lediglich den benutzerdefinierten Link direkt vor das FAQ verschieben.
https://meta.discourse.org/t/custom-hamburger-menu-links/87644/41

[spirobel]

Haha, zufälligerweise schaue ich mir genau dasselbe an. Ich denke, der beste Weg ist, das Hamburger-Menü-Widget erneut zu öffnen und die html-Methode zu überschreiben.

app/assets/javascripts/discourse/app/widgets/hamburger-menu.js

Ich werde mein Widget mit unshift vor das FAQ-Element einfügen. Ich habe noch nicht geprüft, ob es funktioniert, aber das ist mein Ansatz
Hier scheint es zu funktionieren:

  api.reopenWidget("hamburger-menu", {

      html() {
        let conti = this.panelContents()
        conti.unshift(h('div',[h('span','blabla description: '),this.attach('widget-dropdown',
  {id: "from", translatedLabel: "bla",onChange: "changeaction",
  content: [
      { id: 1, label: "foo.bar" },
      { id: 2, translatedLabel: "FooBar" },
      { id: 3, label: "foo.baz", icon: "times" },
      { id: 4, html: "<b>foo</b>" },
    ],
    options: {bodyClass: "lang-drop-body"}
  })]))
        return this.attach("menu-panel", {
          contents: () => conti,
          maxWidth: this.settings.maxWidth
        });
      },
  });

Ich habe zum Beispiel ein Dropdown-Menü hinzugefügt.
Viele Grüße

[ngets]

Hallo, wie kann ich dies direkt nach dem Suchsymbol platzieren? Und wie füge ich benutzerdefiniertes HTML in panelContents ein?