# newsletter-wap

> Documentação do Componente de Newsletter

Latest version **1.0.0** (published 2023-04-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install newsletter-wap
pnpm add newsletter-wap
yarn add newsletter-wap
bun add newsletter-wap
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-04-22 |
| First published | 2023-04-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | desenvolvimento-code |

## Links

- npm: https://www.npmjs.com/package/newsletter-wap
- npm.io page: https://npm.io/package/newsletter-wap

## Recent versions

- 1.0.0 (latest) — 2023-04-22

## README

# **Newsletter**

### **Sobre**

Um componente padrão para a newsletter com os campos de nome e e-mail.

![Newsletter](http://www.codeblue.com.br/wap-docs/newsletter.png)

<br />

***

<br />

## **Dependências**

### **Componentes**

| Prop | Descrição | Instalação | Documentação |
|---|---|---|---|
| Loader `1.3.1` | Um componente que contém um loader padrão em formato de círculo. | `npm install @wapstore/loader` | [Acesse aqui](https://www.npmjs.com/package/@wapstore/loader) |

<br />

***

<br />

## **Instalação**

- Instale o app através do seu terminal

<br />

    npm install @wapstore/newsletter

<br />

- Valide se seu arquivo package.json possui a dependência

<br />

    "dependencies": {
      "@wapstore/newsletter": "^1.3.1"
    }

<br />

Agora a loja está apta para o uso da aplicação.

<br />

***

<br />

## **Uso**

O componente de Newsletter pode ser inserido em qualquer lugar da pasta "components" ou "pages".
Neste arquivo você pode inserir todas as props e slots que o componente aceita, além de seus estilos.

<br />

***

<br />

## **Exemplo**

-Este é um exemplo da aplicação de um arquivo padrão para uma **Newsletter na Home**:

    <template>
      <newsletter placeholderNome="Seu nome" placeholderEmail="Seu melhor e-mail" txtBt="CADASTRAR" class="newsletter">
        <template #newstext>
          <h5>Acompanhe a Loja</h5>
          <p>Cadastre-se e seja um dos primeiros a receber novidades e ofertas.</p>
        </template>
      </newsletter>
    </template>

    <script>
      ...
    </script>
    <style>
      ...
    </style>

<br />

***

<br />

## **Recursos**

### **Props**

| Prop | Descrição | Tipo | Valor padrão |
|---|---|---|---|
| placeholderNome `1.3.1` | Texto placeholder do campo de nome. | `String` | `Nome` |
| placeholderEmail `1.3.1` | Texto placeholder do campo de E-mail. | `String` | `E-mail` |
| txtBt `1.3.1` | Texto do botão enviar. | `String` | `Enviar` |

<br />

### **Slots**

| Slot | Descrição | Name | Exemplo de uso |
|---|---|---|---|
| newstext `1.3.1` | Campo para alteração do texto exibido na newsletter. | `newstext` | `<newsletter><template #newstext>Texto exemplo</template></newsletter>` |
| newsIcon `1.3.1` | Campo para adição de um ícone na newsletter. | `newsIcon` | `<newsletter><template #newsIcon><img src="icone.svg" alt="icone"></template></newsletter>` |

<br />

***

<br />

## Estilização

Para a estilização, basta utilizar estilos sem escopos dentro do componente onde for inserido, utilizando sempre de um ID ou classe específica para a chamada do componente, para que em outras chamadas o estilo não influencie. Caso o estilo seja para várias chamadas do componente é recomendado a inserção dos estilos em um arquivos CSS separado.

---
_Source: https://npm.io/package/newsletter-wap · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
