@dev-tcloud/tcloud-ui 6.22.1 → 6.23.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/tcloud-ui-mark-readme.md +70 -0
- package/fesm2022/dev-tcloud-tcloud-ui.mjs +628 -515
- package/fesm2022/dev-tcloud-tcloud-ui.mjs.map +1 -1
- package/js/tcloud-ui-app.js +2 -2
- package/lib/_modules/tcloud-ui-mark-readme/tcloud-ui-mark-readme.component.d.ts +25 -0
- package/lib/tcloud-ui.module.d.ts +29 -28
- package/package.json +3 -1
- package/public-api.d.ts +1 -0
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Mark Readme
|
|
2
|
+
|
|
3
|
+
## Caracteristicas
|
|
4
|
+
|
|
5
|
+
O `TCloudUiMarkReadmeComponent` e um componente standalone que carrega um arquivo Markdown a partir de `tcloud-ui/docs/{componentName}.md` e o renderiza dentro de um accordion.
|
|
6
|
+
|
|
7
|
+
Funcionalidades principais:
|
|
8
|
+
- Busca o arquivo `.md` via `HttpClient` com base no valor informado em `componentName`.
|
|
9
|
+
- Renderiza o conteudo usando `ngx-markdown`.
|
|
10
|
+
- Exibe a documentacao dentro de `tcloud-ui-accordion`.
|
|
11
|
+
- Executa ajuste de whitespace e tentativa de highlight nos blocos de codigo apos a renderizacao.
|
|
12
|
+
|
|
13
|
+
## Instalacao
|
|
14
|
+
|
|
15
|
+
Importe o componente no consumidor standalone:
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { TCloudUiMarkReadmeComponent } from 'tcloud-ui';
|
|
19
|
+
|
|
20
|
+
@Component({
|
|
21
|
+
selector: 'app-exemplo',
|
|
22
|
+
standalone: true,
|
|
23
|
+
imports: [TCloudUiMarkReadmeComponent],
|
|
24
|
+
template: `...`
|
|
25
|
+
})
|
|
26
|
+
export class ExemploComponent {}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Se a aplicacao utilizar a configuracao standalone da biblioteca, mantenha `provideTCloudUi(...)` no bootstrap para disponibilizar os providers necessarios.
|
|
30
|
+
|
|
31
|
+
## Propriedades (API)
|
|
32
|
+
|
|
33
|
+
### Inputs
|
|
34
|
+
|
|
35
|
+
| Nome | Tipo | Descricao | Valor Default |
|
|
36
|
+
|------|------|-----------|---------------|
|
|
37
|
+
| componentName | `string` | Nome do arquivo de documentacao sem a extensao. O componente vai buscar `tcloud-ui/docs/{componentName}.md`. | `''` |
|
|
38
|
+
|
|
39
|
+
### Outputs
|
|
40
|
+
|
|
41
|
+
Este componente nao possui `@Output()` publicos.
|
|
42
|
+
|
|
43
|
+
## Exemplos de Uso
|
|
44
|
+
|
|
45
|
+
### Uso Basico
|
|
46
|
+
|
|
47
|
+
```html
|
|
48
|
+
<tcloud-ui-mark-readme [componentName]="'tcloud-ui-accordion'"></tcloud-ui-mark-readme>
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Uso Avancado
|
|
52
|
+
|
|
53
|
+
```typescript
|
|
54
|
+
import { Component } from '@angular/core';
|
|
55
|
+
import { TCloudUiMarkReadmeComponent } from 'tcloud-ui';
|
|
56
|
+
|
|
57
|
+
@Component({
|
|
58
|
+
selector: 'app-exemplo',
|
|
59
|
+
standalone: true,
|
|
60
|
+
imports: [TCloudUiMarkReadmeComponent],
|
|
61
|
+
template: `
|
|
62
|
+
<tcloud-ui-mark-readme [componentName]="selectedDoc"></tcloud-ui-mark-readme>
|
|
63
|
+
`
|
|
64
|
+
})
|
|
65
|
+
export class ExemploComponent {
|
|
66
|
+
selectedDoc = 'tcloud-ui-filter-bar';
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Neste formato, a pagina pode alternar dinamicamente qual documentacao sera carregada e exibida pelo componente.
|