A tour of how the Widget (Virtual DOM) code in Discourse works

Разработка
61

Right, after a lot of headaches I’ve got it working - thanks for the help! :tada:

The two other problems I hit which could possibly do with some re-engineering in the widget code:

  • When setting dirtyKeys, it only re-renders the first widget with that buildKey. I’ve got around that by adding the post-id to the post-avatar’s buildKey so that every buildKey is unique
  • Setting the dirtyKey doesn’t work if the widget you want to re-render is inside another widget. In my case the post-avatar is inside a post. I think this is because of the shadowTree stuff.
    It would be really nice if the widget code could work out that the widget is deep in the tree and re-render its parents. I’ve got around this by setting the post widget as dirty as well.
62

That’s because keys are supposed to be unique! So adding the post id to the avatar is correct in this case. I might want to raise an error in development mode if two elements use the same keys. If you want to commit the post avatar key to master that would be fine.

That’s exactly what it is. By default I think a widget is supposed to re-render its parents, but the shadowTree is a performance optimization that avoids too much re-rendering and requires you to be more explicit.

63

Just in case anyone is trying to track down how widgets can use handlebars templates, see the commit message here (can’t find it documented anywhere on meta):

https://github.com/discourse/discourse/commit/dffb1fc4ee8a4d58f48145decb1590a304e8cf7d

64

Как создать панель навигации? С помощью виджета.

Вот пример

image

65

Приведённый ниже код из инструкции больше не работает. Рендеринг выполняется, но состояние не увеличивается при кликах:

<script type="text/javascript">
        const { createWidget } = require('discourse/widgets/widget');

        createWidget('increment-button', {
            tagName: 'button',

            defaultState() {
                return { clicks: 0 };
            },

            html(attrs, state) {
                return `Click me! ${state.clicks} clicks`;
            },

            click() {
                this.state.clicks++;
            }
        });
</script>


<script type='text/x-handlebars' data-template-name='/connectors/above-footer/increment-button'>
    {{mount-widget widget="increment-button" }}
</script>
66

Странно, у меня этот компонент вообще не рендерится, потому что отсутствует key. Я обновил документацию выше, добавив метод buildKey, и у меня всё работает. Попробуй.

67

Спасибо @eviltrout, мне удалось это настроить! Большое спасибо!

68

Как можно отрендерить HTML, приходящий из аргумента, в виджет? Сейчас он экранирует HTML и отображает его как есть.

Также не работает следующий пример:

Кажется, переменная user равна null. Нужно ли мне что-то сделать, чтобы передать user в hbs, откуда монтируется виджет?

69

Нашел ответ на этот вопрос:

Ответ:

import { createWidget } from 'discourse/widgets/widget';
import RawHtml from "discourse/widgets/raw-html";

createWidget('display-name', {
  tagName: 'div.name',

  html() {
    return new RawHtml({ html: `<div>${this.siteSettings.user_rank_alert_message}</div>` });
  }
});

Но я всё ещё не знаю, как получить данные пользователя в коннекторе hbs, когда данные не передаются из outlet.

70

посмотри на тройные фигурные скобки, бро :smiley:

71

Погодите :wink: :warning: :

72

Вместо тройных фигурных скобок можно использовать специальный помощник:

{{html-safe result}}
73

Привет @eviltrout,

Я заметил в первом сообщении этой темы, что вы пишете:

Но ниже в этой теме вы упоминаете:

Не могли бы вы исправить первое сообщение?

74

Спасибо, я внес это изменение.

75

@eviltrout Разве это не должно быть action="deleteThing"?

76

Это зависит от вашего виджета. В примере от @eviltrout виджет my-widget ожидает получить действие с именем «deleteThing». Разные виджеты используют разные имена для своих действий (и, в самом деле, возможно, что они называют своё действие «action»).