Começar
Essa documentação cobre a integração com os widgets da Volt.
Todos os Widgets são servidos através de um pequeno bundle de JavaScript que funciona em qualquer navegador moderno. Ele instala nossos Web Components que você pode usar para adicionar funcionalidades específicas da Volt ao seu site.
Dependências
Todas as dependências já estão incluídas no script. Elas são:
- Vue 3.4.15 ou mais recente
- Pinia 2.1.7 ou mais recente
- Maska 3.0.0-beta5 ou mais recente
Bundles menores sem dependências estão planejados para serem servidos no futuro próximo.
Autenticação
A autenticação é feita lendo o atributo id da tag HTML do widget.
O método de autenticação mudará no futuro distante.
Cada widget precisa receber seu hash de identificação exclusivo para ser instalado no DOM. O hash de identificação é fornecido por nós a você mediante solicitação.
Depois de ter o hash, você pode adicioná-lo a qualquer tag HTML de widget como esta:
<c1-some-widget id="yourIdGoesHere" />
Ele deve estar presente quando o script é carregado no navegador. Não é reativo, o que significa que pode ser removido após window.$volt_ready ser chamado.
Opções
Opções são passadas para nossos widgets através de atributos HTML. Cada widget tem seu próprio conjunto de opções.
Atributos Boolean
Atributos booleanos são atributos que podem indicar valores verdadeiro / falso por sua presença em um elemento. Por exemplo:
<c1-some-widget popoup />
É equivalente a:
<c1-some-widget popup="true" />
Utilização
Primeiro adicione nosso bundle antes do final da tag <body>:
<script src="https://widget.voltdigital.com.br/voltweb.umd-module.js">
Agora inclua o widget desejado em qualquer lugar do seu HTML e substitua yourIdGoesHere pelo seu Hash de Identificação Exclusivo:
<c1-some-widget id="yourIdGoesHere" />
Confira todos os Widgets disponíveis no bundle na seção de Widgets. Novos Widgets serão adicionados em breve.