Guia de componentes da comunidade community-components-guide

O guia Componentes da comunidade é uma ferramenta de desenvolvimento interativa para a estrutura da componente social (SCF). Ele fornece uma lista de componentes disponíveis das Comunidades Adobe Experience Manager (AEM) ou os recursos mais complexos criados com vários componentes.

Juntamente com as informações básicas de cada componente, o guia permite a experimentação de como os componentes/recursos do SCF funcionam e como eles podem ser configurados ou personalizados.

Para obter informações sobre os fundamentos de desenvolvimento relacionados a cada componente, consulte Fundamentos de recursos e componentes.

Introdução getting-started

O guia deve ser usado em instalações de desenvolvimento de instâncias de autor (localhost:4502) e instâncias de publicação (localhost:4503).

O site Componentes da comunidade é acessado navegando até

As interações com os componentes das Comunidades variam de acordo com:

  • O servidor (autor ou publicação).
  • Se o visitante do site está conectado ou não.
  • Se estiver conectado, os privilégios atribuídos ao membro.
  • Se o SRP padrão, JSRP, está em uso.

No autor, para entrar no modo de edição, insira editor.html ou cf# como o primeiro segmento de caminho após o nome do servidor:

NOTE
Quando o autor está no modo de Edição, os links em uma página não estão ativos.
Para navegar até uma página de componente, primeiro selecione o modo Visualização para ativar os links.
Com a página do componente exibida no navegador, volte para o modo Editar para abrir a caixa de diálogo de edição do componente.
Para obter informações gerais sobre criação, consulte guia rápido para a criação de páginas.
Se não estiver familiarizado com o AEM, consulte a documentação em manuseio básico.

Página Inicial home-page

O guia fornece uma lista de componentes SCF disponíveis para visualização e protótipo no lado esquerdo da página.

O Guia de componentes conforme visualizado em uma instância do autor no modo Editar:

community-component1

Páginas de componentes component-pages

Selecione um componente na lista do lado esquerdo da página.

comunidade-componente-páginas

O corpo principal do guia é exibido:

  1. Título: o nome do componente selecionado

  2. Bibliotecas do lado do cliente: uma lista de uma ou mais categorias necessárias

  3. Incluível: se o componente puder ser incluído dinamicamente, o estado poderá ser alternado no modo de edição do autor:

    • Se adicionado, o texto exibido é: "Este componente é incluído por meio de seu nó par".
    • Se incluído, o texto exibido é: "Este componente é incluído dinamicamente".
    • Se não puder ser incluído, o texto não será exibido
  4. Componente ou recurso de amostra: uma instância ativa do componente ou recurso. Se for um componente, ele poderá ser alterado com as alterações feitas nos modelos, CSS e dados fornecidos na seção da guia.

NOTE
Depois de fazer uma seleção no lado esquerdo, o componente aparecerá abaixo, em vez de ao lado, da lista de componentes quando a janela do navegador for muito estreita.

Interações do autor author-interactions

Ao usar o guia em uma instância do autor, é possível executar a configuração de um componente abrindo a caixa de diálogo. As informações para desenvolvedores são fornecidas no Fundamentos de componentes e recursos seção da documentação, enquanto as configurações da caixa de diálogo estão descritas em Componentes das comunidades seção para autores.

Para o guia Componentes da comunidade, algumas configurações da caixa de diálogo do componente são sobrepostas com a Incluível alternar estado. Para alternar entre o uso do recurso existente ou de um recurso incluído dinamicamente, no modo de edição, selecione o componente e o texto incluível e clique duas vezes para abrir a caixa de diálogo de edição:

community-component3

No Modelos guia:

community-component4

  • Incluir o componente-filho com sling:include

    Se desmarcado, o Guia de componentes usará o recurso existente no repositório (um nó jcr que é filho de um nó par).

    • o texto exibido é: "Este componente é incluído por meio de seu nó par".

    Se marcado, o Guia do componente usará o sling para incluir dinamicamente um componente do resourceType do nó secundário (recurso não existente).

    • o texto exibido é: "Este componente é incluído dinamicamente."

    O padrão está desmarcado.

Publicar interações publish-interactions

Ao usar o guia em uma instância de publicação, é possível experimentar os componentes e recursos como um visitante do site (não conectado) e como membros com vários privilégios quando conectados.

NOTE
Esteja ciente de que, se o SRP for deixado com o padrão de JSRP, o UGC inserido na instância de publicação só estará visível na publicação e não ser visível do moderação na instância do autor.

Bibliotecas do lado do cliente client-side-libraries

As bibliotecas do lado do cliente (clientlibs) listadas para cada componente são aquelas obrigatório para ser referenciado quando o componente for colocado em uma página. As clientlibs fornecem um meio de gerenciar e otimizar o download do JavaScript e do CSS usados para renderizar o componente no navegador.

Para obter mais informações, visite Clientlibs para componentes das comunidades.

Representação impersonation

Na instância do autor, onde um usuário está conectado com frequência como administrador ou desenvolvedor, para experimentar o componente conectado como outro usuário, use a caixa de texto à esquerda do Representar para digitar o nome de usuário ou selecione na lista suspensa e clique no botão. Clique em Reverter para sair e encerrar a representação.

A instância de publicação não precisa representar. Basta usar o link Login/Logout para representar vários usuários, como o usuários de demonstração.

Personalização customization

Quando ativado, cada componente do SCF está disponível para prototipar de possíveis personalizações, modificando temporariamente o modelo, o CSS e os dados do componente.

Habilitando a personalização enabling-customization

NOTE
Esta ferramenta é somente leitura. Nenhuma das edições feitas em modelos, CSS ou dados é salva no repositório.

Para experimentar rapidamente com personalizações, a variável scg:showIdeA propriedade deve ser adicionada ao nó JCR de conteúdo da página de componentes e definida como true.

Usando o componente de comentários como exemplo, na instância do autor ou de publicação, conectada com privilégios de administrador:

  1. Navegue até CRXDE Lite

    Por exemplo, http://localhost:4503/crx/de

  2. Selecione o jcr:content

    Por exemplo, /content/community-components/en/comments/jcr:content

  3. Adicionar uma propriedade do

    • Nome scg:showIde
    • Tipo String
    • Valor true
  4. Selecionar Salvar tudo

  5. Recarregar a página Comentários no guia

    http://localhost:4503/content/community-components/en/comments.html

  6. Observe que agora há três guias para Modelos, CSS e Dados.

community-component5

community-component6

Guia Modelos templates-tab

Selecione a guia templates para ver os templates associados ao componente.

O Editor de modelo permite que edições locais sejam compiladas e aplicadas à instância do componente de amostra na parte superior da página, sem afetar o componente no repositório.

Executar a compilação em edições locais destacará os erros ao colocar um ponto na medianiz e marcar o texto como vermelho.

Guia CSS css-tab

Selecione a guia CSS para ver o CSS associado ao componente.

Se um componente for composto por vários componentes, alguns CSS podem ser listados em um dos outros componentes.

O Editor de CSS permite que o CSS seja modificado e aplicado à instância do componente de amostra na parte superior da página.

Uma regra pode ser selecionada para realçar as partes do DOM que usam essa regra clicando ao lado da regra na medianiz.

Guia Dados data-tab

Selecione a guia Dados para mostrar os dados do ponto de extremidade .social.json. Esses dados são editáveis e são aplicados à instância do componente de amostra.

Os erros de sintaxe podem ser marcados na medianiz e destacados no editor.

recommendation-more-help
81e2cd9d-0789-409d-b87c-2a8ce4f28791