Seção de mensagens para a barra lateral

[Moin]

	Resumo	Adiciona links para caixas de entrada de mensagens pessoais e de grupo na barra lateral, incluindo indicadores de mensagens não lidas
	Pré-visualização	Theme Creator
	Repositório	GitHub - moin-Jana/sidebar-messages-section: Adds personal and group message inbox links to the sidebar, including unread message indicators. · GitHub
	Guia de Instalação	Como instalar um tema ou componente de tema
	Novo em Temas do Discourse?	Guia para iniciantes sobre o uso de Temas do Discourse

Instale este componente de tema

O componente adiciona uma seção Mensagens à barra lateral com links para caixas de entrada de mensagens pessoais — tanto a caixa de entrada pessoal do usuário quanto qualquer caixa de entrada de grupo à qual ele tenha acesso. A seção também inclui um botão para redigir uma nova mensagem pessoal ao lado do título da seção.

Caixa de entrada pessoal

Por padrão, o componente adiciona um link para a caixa de entrada pessoal para todos os usuários. Com a configuração show_personal_inbox, os administradores também podem ocultá-la completamente ou mostrá-la apenas para usuários que têm permissão para criar mensagens privadas, com base na configuração do site “Grupos com mensagens privadas habilitadas”. Isso reflete como o link da caixa de entrada pessoal aparece no menu de notificações, no perfil do usuário e na seção Comunidade da barra lateral.

Para evitar links duplicados para a caixa de entrada pessoal, você pode querer remover o link de mensagens na primeira seção da barra lateral. Para fazer isso, abra o menu Mais e selecione Personalizar esta seção, depois remova o link de Mensagens da seção.

Caixas de entrada de grupo

Todas as caixas de entrada de grupo que contêm pelo menos uma mensagem e das quais o usuário é membro aparecerão automaticamente em sua barra lateral. Os administradores podem ocultar caixas de entrada de grupo específicas usando a configuração hide_group_inboxes, o que pode ser útil quando uma caixa de entrada de grupo não é mais usada ativamente.

Uma configuração separada, use_group_page_inbox, permite escolher se os links das caixas de entrada de grupo abrem na interface de mensagens do usuário (/my/messages/group/{group_name}) ou na página do grupo (/g/{group_name}/messages/inbox).

Indicador de não lido

Cada link de caixa de entrada mostra o estado atual da mensagem com base na preferência do usuário para “Mostrar uma contagem dos novos itens”: seja um ponto ou a contagem numérica. Valores acima de 100 são exibidos como 99+.

Configuração avançada de caixa de entrada de grupo

Para personalizar a ordem das caixas de entrada de grupo ou alterar o nome exibido na barra lateral, você pode usar a configuração advanced_group_inbox_configuration.

Nesta configuração, você pode:

• selecionar um grupo em um menu suspenso
• opcionalmente definir um nome personalizado que será exibido na barra lateral
• reordenar os grupos configurados usando os botões na parte inferior

O nome personalizado também é útil dentro da configuração em si.
Se nenhum nome for fornecido, a entrada será rotulada como grupo 1, grupo 2, etc. (com base em sua posição). Adicionar um nome temporário pode facilitar a reordenação, e você pode removê-lo novamente antes de salvar, se desejar.

Grupos com mensagens que não foram adicionados à configuração avançada ainda aparecerão na barra lateral, listados após os configurados e ordenados por seu ID de grupo.

Grupos listados na configuração hide_group_inboxes serão sempre ocultos, independentemente de estarem também presentes na configuração avançada ou terem mensagens. Um aviso exclusivo para administradores ajuda a destacar quando um grupo é adicionado a ambas as configurações.

Você pode ver um exemplo de configuração e como ela afeta a ordem e os nomes exibidos nas capturas de tela abaixo:

Posição da seção de mensagens

Para alterar a posição da seção de mensagens, você pode usar CSS, por exemplo:

@nathank

/* Garante que a seção Mensagens apareça primeiro no contêiner flexbox */
.sidebar-section-wrapper {
  order: 1;
}
.sidebar-section-wrapper[data-section-name="inbox-section"] {
  order: 0;
}

Alternativamente, você pode instalar o componente Discourse Sidebar Menu Reorder e usar inbox-section como o nome da seção ao ajustar sua posição. Você também pode usar a configuração de ordem do componente Controle de exibição do menu de navegação (barra lateral).

[Lilly]

Uau, bem feito Moin!

[NateDhaliwal]

Sugestão menor: talvez javascripts/discourse/api-initializers/group-inboxes-in-sidebar.gjs devesse ser um arquivo JS em vez de GJS?

Ótimo componente!

---

Passei os últimos 10 minutos examinando o código e analisando as classes principais e devo dizer o quão notável o Discourse foi (e é) feito de modo que tudo se encaixa tão bem.

[Moin]

Sim, a API oferece quase tudo o que você precisa para fazer a seção parecer e funcionar como todas as outras. O chat também a utiliza, o que provavelmente influenciou o desenvolvimento. Os recursos foram desenvolvidos ao mesmo tempo.
Infelizmente, get badgeText(), que exibe o número de tópicos não lidos nas seções principais, não é suportado, então tive que ser um pouco criativo com os números.

[putty (Derek Putnam)]

@Moin

Para evitar links duplicados para a caixa de entrada pessoal, você pode querer remover o link de mensagens na primeira seção da barra lateral.

Não consegui encontrar uma configuração de administrador para isso, então um PSA: isso a ocultará via CSS:

.sidebar-section-link[data-link-name=\"my-messages\"] {
    display: none;
}

[Moin]

Por que você prefere que o link fique oculto com CSS em vez de usar a opção existente para administradores personalizarem a barra lateral? Ocultar com CSS parece ter mais probabilidade de quebrar do que usar as opções integradas do Discourse.

@Moin

Para personalizar esta seção:

1. Clique em Mais na barra lateral
2. Selecione Personalizar esta seção na parte inferior do menu estendido

[putty (Derek Putnam)]

Derp, você está certo. Eu estava pensando demais, achando que seria uma configuração no console de administração e/ou funcionalidade principal.

[Heliosurge (Dan DeMontmorency)]

Você não é o único que estava olhando lá.

---

Este é um componente adorável!

[Moin]

Eu expandi a nota:

@Moin

Para evitar links duplicados para a caixa de entrada pessoal, você pode querer remover o link de mensagens na primeira seção da barra lateral. Você pode fazer isso abrindo o menu Mais e selecionando Personalizar esta seção, depois remova o link Mensagens da seção.

[Heliosurge (Dan DeMontmorency)]

Sim, você fez. Mas como administradores, muitas vezes estamos acostumados a passar pelo painel de administração. . Então, ao folhear as instruções, podemos ignorar alguns detalhes.

Mesmo com atualizações principais, tenho certeza de que muitos de nós nem sempre lemos todos os detalhes minuciosos até que algo que usamos tenha sido movido para outra área.

Há muito, muito tempo, com o Android, se bem me lembro, o Gingerbread costumava ter Navegação e Mapas. Passei cerca de 10 minutos procurando por Navegação depois que eles a fundiram com Mapas em uma atualização.

[nathank (Nathan Kershaw)]

Este é um Componente de Tema brilhante que se adequa a sites que dependem muito de Mensagens! Obrigado @moin pelo seu excelente trabalho!

Para torná-lo ainda melhor para aqueles que usam Grupos com frequência (Mensagens são um grande componente disso), você se importaria de considerar estas sugestões?

Posição selecionável na barra lateral

Para enfatizar mais as Mensagens na interface do usuário, eu gostaria que elas ficassem no topo da Barra Lateral (ou seja, logo abaixo dos links). Basicamente, quero que as pessoas possam ver facilmente suas Mensagens recentes (por grupo) rapidamente, sem depender de notificações.

Eu usei este CSS para conseguir isso, mas suspeito que não sou o único para quem isso seria útil:

/* Garante que a seção Mensagens apareça primeiro no contêiner flexbox */
.sidebar-section-wrapper {
  order: 1;
}
.sidebar-section-wrapper[data-section-name="inbox-section"] {
  order: 0;
}

Abrir caixas de entrada de grupo no contexto do grupo

Quero que meus usuários possam encontrar e interagir facilmente com seus Grupos. Faz sentido para mim que eles trabalhem com Mensagens na Caixa de Entrada que é acessada a partir da página do Grupo (ou seja, /g/o-grupo/mensagens/caixa-de-entrada) em vez da página da Caixa de Entrada Pessoal (ou seja, /meu/mensagens/grupo/o-grupo)

Isso lhes dá uma página limpa centrada no grupo, com fácil acesso aos outros membros e configurações do grupo:

Seria ótimo ter isso controlado por uma configuração no TC.

[Moin]

@nathank

Seria ótimo ter isso governado por uma configuração no TC.

Eu pensei sobre isso, sobre qual rota é um padrão melhor e uma configuração, mas a removi por algum motivo que não me lembro agora. Vou dar uma olhada amanhã mais tarde. Acho que foi sobre o indicador de mensagem não lida. Você ainda preferiria esta rota se a consequência fosse que não haveria indicador para mensagens não lidas?

Eu acho que a posição atual é a mesma da seção de mensagens que estava no núcleo.
Já existe um ótimo componente sobre a alteração da ordem das seções na barra lateral: Navigation (sidebar) menu display control
Para evitar conflitos porque ambos os componentes tentam substituir a ordem, pode fazer sentido que administradores que desejam uma ordem diferente usem o componente existente (O autor confirmou que funciona usando “inbox-section” como nome da seção).
Terei que ver se consigo oferecer uma configuração adicional para isso. Em qualquer caso, quero evitar que os componentes interfiram uns com os outros.

[nathank (Nathan Kershaw)]

@Moin

Pensei sobre isso, sobre qual rota seria uma melhor opção padrão e uma configuração, mas a removi por algum motivo que não me lembro agora. Vou dar uma olhada amanhã depois. Acho que era sobre o indicador de mensagem não lida. Você ainda preferiria esta rota se a consequência fosse que não haveria indicador para mensagens não lidas?

Tenho mexido nisso no meu fork e descobri a mesma coisa. Funciona, mas perde tanto o indicador de mensagem não lida quanto o destaque do link na barra lateral. Ambas essas coisas são de alto valor!

Fiz um PR sobre onde cheguei:

Add group page inbox as an option

Mas para realmente funcionar, precisa que o indicador de não lido e o destaque do link funcionem, né?

@Moin

Já existe um ótimo componente sobre como alterar a ordem das seções na barra lateral: Controle de exibição do menu de navegação (barra lateral)

Ponto bem colocado! Essa é uma ideia muito melhor. Para minha vergonha, sou um dos autores desse TC!

[Moin]

Por que você usou href em vez de route? Eu acho que href não funcionava com indicadores de não lido de jeito nenhum. Eu estava mais preocupado que os números na rota group.messages.inbox não estivessem disponíveis da maneira que você pode usá-los em userPrivateMessages.

[nathank (Nathan Kershaw)]

Porque sou um desenvolvedor ruim e tentei várias coisas até que algo funcionasse! Provavelmente também devido à minha dependência pouco saudável de IA generativa nem tão inteligente .

Tentei utilizar rotas, mas não consegui realmente sobrescrever as rotas existentes. Então desisti.

Cheguei a me perguntar se seria possível obter esses números/comportamento simplesmente sequestrando o link para ir a um local diferente. Mas isso é um pouco complexo para mim, o velho simples.

Fique à vontade para ‘melhorar’ isso!

(Aliás, o maravilhoso @moin fez exatamente isso, adicionando a funcionalidade e fazendo tudo funcionar corretamente!)

[nathank (Nathan Kershaw)]

@Moin

Eu acho que a posição atual é a mesma da seção de mensagens que estava no core.
Já existe um ótimo componente sobre a alteração da ordem das seções na barra lateral: Navigation (sidebar) menu display control
Para evitar conflitos porque ambos os componentes tentam sobrescrever a ordem, pode fazer sentido que os administradores que desejam uma ordem diferente usem o componente existente (O autor confirmou que funciona usando “inbox-section” como nome da seção).

Isso realmente funciona muito bem. De forma um pouco embaraçosa, sou um dos autores (muito secundário a @lilly) da aquele TC !

Seria ótimo ter isso no OP.

[Moin]

@nathank solicitou uma opção para alterar a ordem das caixas de entrada de grupo na barra lateral. Eu pedi ideias sobre a melhor forma de abordar isso anteriormente em Configuring the order of groups in theme component settings, e acho que cheguei a uma solução.
Combinei isso com o pedido para exibir o nome completo de um grupo em vez de seu nome curto. Como o nome completo não está facilmente disponível neste contexto, a solução é permitir que os administradores definam um nome de exibição personalizado em vez disso. O campo que anteriormente seria usado apenas para exibir o nome do grupo na configuração agora também é usado para controlar o nome mostrado na barra lateral.

Ambos os recursos são tratados através da nova configuração advanced_group_inbox_configuration.

Nesta configuração você pode:

• selecionar um grupo em um menu suspenso
• opcionalmente, definir um nome personalizado que será exibido na barra lateral
• reordenar os grupos configurados usando os botões na parte inferior

O nome personalizado também é útil dentro da própria configuração.
Se nenhum nome for fornecido, a entrada será rotulada como group 1, group 2, etc. (com base em sua posição). Adicionar um nome temporário pode facilitar a reordenação, e você pode removê-lo novamente antes de salvar, se desejar.

Grupos com mensagens que não são adicionados à configuração avançada ainda aparecerão na barra lateral, listados após os configurados e ordenados pelo seu ID de grupo.
Grupos listados na configuração hide_group_inboxes sempre serão ocultados, independentemente de também estarem presentes na configuração avançada ou terem mensagens.

Neste exemplo, nenhum nome personalizado foi inserido para o grupo de moderadores, razão pela qual ele aparece como group 1 na configuração. Os outros grupos têm nomes personalizados.

Esta configuração resulta em:

Aqui você pode ver que as caixas de entrada ‘doggo-daily’ e ‘cat_pics’ trocaram de posição e são exibidas sem hifens ou sublinhados. A caixa de entrada ‘Team’ aparece abaixo daquelas configuradas na configuração avançada.
Você também pode ver um aviso exclusivo para administradores, que aparece porque o grupo ‘admin’ foi adicionado à configuração avançada e à configuração hide_group_inboxes ao mesmo tempo.

[nathank (Nathan Kershaw)]

Isto é simplesmente brilhante para aqueles que estão utilizando grupos para comunicações. Ótimo trabalho, @Moin!

Obrigado por ouvir e se envolver ativamente com o feedback dos outros (e meu) — e por produzir um componente de tema tão bem projetado e pragmático que resolve um problema antigo com tanta elegância.

[agit (Bren Typo)]

Olá @Moin, ótimo trabalho e muito obrigado.

Eu estava perguntando se uma funcionalidade, especialmente quando se trabalha com muitos grupos, poderia fazer parte deste plugin. A visualização combinada de todas as mensagens de grupo. Na visualização PN já existe uma forma de visualizar com um pequeno emblema que esta mensagem também vai para o grupo, por que não mostrar todas as mensagens com emblemas a qual grupo ela pertence:

[Moin]

@agit

Eu estava perguntando se um recurso, especialmente quando se trabalha com muitos grupos, poderia fazer parte deste plugin.

Eu não acho que isso se encaixaria bem neste componente de tema. O objetivo deste componente é muito restrito: ele adiciona uma seção de mensagens à barra lateral. Eu não sou a favor de um componente que suporte recursos completamente diferentes, pois isso torna mais difícil de entender e manter. Esse tipo de funcionalidade seria melhor tratado como uma personalização separada.

Mais importante ainda, isso não é algo para o qual um componente de tema seja bem adequado. Componentes de tema só podem funcionar com dados que já existem no frontend, ou que podem ser razoavelmente buscados de endpoints de backend existentes. É por isso que este componente pode mostrar caixas de entrada de grupos na barra lateral: muitas partes do Discourse já precisam saber a quais grupos um usuário pertence, então essa informação está prontamente disponível.

No entanto, o que você está descrevendo exigiria acesso aos dados de mensagens em todas as caixas de entrada de grupos. O Discourse atualmente não expõe isso em um único lugar. Um componente de tema poderia teoricamente buscar cada caixa de entrada de grupo uma por uma, mas isso rapidamente se torna ineficiente. Cada solicitação retorna apenas as primeiras 30 mensagens, então você precisaria carregar várias páginas por caixa de entrada. Para então ordenar as mensagens por atividade, você precisaria efetivamente de todas as mensagens de todas as caixas de entrada ao mesmo tempo.

Devido a essas limitações, um componente de tema seria uma má escolha aqui. Um plugin que adiciona um endpoint de backend adequado para retornar esses dados seria uma abordagem muito mais sensata e escalável.