@praxisui/dynamic-fields 8.0.0-beta.9 → 8.0.0-beta.91
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/README.md +19 -0
- package/docs/dynamic-fields-field-catalog.md +217 -0
- package/docs/dynamic-fields-field-selection-guide.md +204 -0
- package/docs/dynamic-fields-host-custom-field-guide.md +252 -0
- package/docs/dynamic-fields-host-custom-field-troubleshooting.md +160 -0
- package/docs/dynamic-fields-inline-components-guide.md +582 -0
- package/docs/dynamic-fields-inline-filter-catalog.md +518 -0
- package/docs/dynamic-fields-inline-filter-custom-component-guide.md +241 -0
- package/docs/dynamic-fields-inline-filter-inventory.md +250 -0
- package/docs/dynamic-fields-inline-filter-runtime-contract.md +394 -0
- package/docs/dynamic-fields-inline-filter-selection-guide.md +419 -0
- package/docs/dynamic-fields-inline-filter-troubleshooting.md +201 -0
- package/docs/dynamic-fields-inventory.md +207 -0
- package/docs/dynamic-fields-playground-catalog-plan.md +243 -0
- package/docs/generic-crud-service.md +152 -0
- package/fesm2022/praxisui-dynamic-fields-index-BYVmv78m.mjs +1 -0
- package/fesm2022/praxisui-dynamic-fields-index-CWPZdn1Y.mjs +6 -0
- package/fesm2022/praxisui-dynamic-fields-index-CrHhyUMO.mjs +1 -0
- package/fesm2022/praxisui-dynamic-fields-index-DhGo5In4.mjs +6 -0
- package/fesm2022/praxisui-dynamic-fields.mjs +14500 -5745
- package/package.json +14 -13
- package/src/lib/base/pdx-base-input-runtime-contract.json-api.md +526 -0
- package/src/lib/base/pdx-base-select-runtime-contract.json-api.md +474 -0
- package/src/lib/components/color-input/pdx-color-input.json-api.md +573 -0
- package/src/lib/components/color-picker/pdx-color-picker.json-api.md +686 -0
- package/src/lib/components/date-input/pdx-date-input.json-api.md +581 -0
- package/src/lib/components/datetime-local-input/pdx-datetime-local-input.json-api.md +560 -0
- package/src/lib/components/email-input/pdx-email-input.json-api.md +546 -0
- package/src/lib/components/field-shell/praxis-field-shell.json-api.md +523 -0
- package/src/lib/components/inline-async-select/pdx-inline-async-select.json-api.md +566 -0
- package/src/lib/components/inline-autocomplete/pdx-inline-autocomplete.json-api.md +554 -0
- package/src/lib/components/inline-color-label/pdx-inline-color-label.json-api.md +615 -0
- package/src/lib/components/inline-currency/pdx-inline-currency.json-api.md +542 -0
- package/src/lib/components/inline-currency-range/pdx-inline-currency-range.json-api.md +630 -0
- package/src/lib/components/inline-date/pdx-inline-date.json-api.md +529 -0
- package/src/lib/components/inline-date-range/pdx-inline-date-range.json-api.md +592 -0
- package/src/lib/components/inline-distance-radius/pdx-inline-distance-radius.json-api.md +649 -0
- package/src/lib/components/inline-entity-lookup/pdx-inline-entity-lookup.json-api.md +656 -0
- package/src/lib/components/inline-input/pdx-inline-input.json-api.md +538 -0
- package/src/lib/components/inline-multi-select/pdx-inline-multi-select.json-api.md +566 -0
- package/src/lib/components/inline-number/pdx-inline-number.json-api.md +533 -0
- package/src/lib/components/inline-pipeline-status/pdx-inline-pipeline-status.json-api.md +619 -0
- package/src/lib/components/inline-range-slider/pdx-inline-range-slider.json-api.md +605 -0
- package/src/lib/components/inline-rating/pdx-inline-rating.json-api.md +594 -0
- package/src/lib/components/inline-relative-period/pdx-inline-relative-period.json-api.md +623 -0
- package/src/lib/components/inline-score-priority/pdx-inline-score-priority.json-api.md +632 -0
- package/src/lib/components/inline-searchable-select/pdx-inline-searchable-select.json-api.md +564 -0
- package/src/lib/components/inline-select/pdx-inline-select.json-api.md +571 -0
- package/src/lib/components/inline-sentiment/pdx-inline-sentiment.json-api.md +661 -0
- package/src/lib/components/inline-time/pdx-inline-time.json-api.md +573 -0
- package/src/lib/components/inline-time-range/pdx-inline-time-range.json-api.md +635 -0
- package/src/lib/components/inline-toggle/pdx-inline-toggle.json-api.md +516 -0
- package/src/lib/components/inline-tree-select/pdx-inline-tree-select.json-api.md +637 -0
- package/src/lib/components/material-async-select/pdx-material-async-select.json-api.md +566 -0
- package/src/lib/components/material-autocomplete/pdx-material-autocomplete.json-api.md +561 -0
- package/src/lib/components/material-avatar/pdx-material-avatar.json-api.md +670 -0
- package/src/lib/components/material-button/pdx-material-button.json-api.md +572 -0
- package/src/lib/components/material-button-toggle/pdx-material-button-toggle.json-api.md +577 -0
- package/src/lib/components/material-checkbox-group/pdx-material-checkbox-group.json-api.md +611 -0
- package/src/lib/components/material-chips/pdx-material-chips.json-api.md +601 -0
- package/src/lib/components/material-colorpicker/pdx-material-colorpicker.json-api.md +545 -0
- package/src/lib/components/material-cpf-cnpj-input/pdx-material-cpf-cnpj-input.json-api.md +531 -0
- package/src/lib/components/material-currency/pdx-material-currency.json-api.md +569 -0
- package/src/lib/components/material-date-range/pdx-material-date-range.json-api.md +636 -0
- package/src/lib/components/material-datepicker/pdx-material-datepicker.json-api.md +556 -0
- package/src/lib/components/material-file-upload/pdx-material-file-upload.json-api.md +511 -0
- package/src/lib/components/material-multi-select/pdx-material-multi-select.json-api.md +596 -0
- package/src/lib/components/material-multi-select-tree/pdx-material-multi-select-tree.json-api.md +623 -0
- package/src/lib/components/material-price-range/pdx-material-price-range.json-api.md +619 -0
- package/src/lib/components/material-radio-group/pdx-material-radio-group.json-api.md +585 -0
- package/src/lib/components/material-range-slider/pdx-material-range-slider.json-api.md +664 -0
- package/src/lib/components/material-rating/pdx-material-rating.json-api.md +551 -0
- package/src/lib/components/material-searchable-select/pdx-material-searchable-select.json-api.md +602 -0
- package/src/lib/components/material-select/pdx-material-select.json-api.md +601 -0
- package/src/lib/components/material-selection-list/pdx-material-selection-list.json-api.md +607 -0
- package/src/lib/components/material-slide-toggle/pdx-material-slide-toggle.json-api.md +522 -0
- package/src/lib/components/material-slider/pdx-material-slider.json-api.md +602 -0
- package/src/lib/components/material-textarea/pdx-material-textarea.json-api.md +598 -0
- package/src/lib/components/material-timepicker/pdx-material-timepicker.json-api.md +554 -0
- package/src/lib/components/material-transfer-list/pdx-material-transfer-list.json-api.md +614 -0
- package/src/lib/components/material-tree-select/pdx-material-tree-select.json-api.md +649 -0
- package/src/lib/components/month-input/pdx-month-input.json-api.md +527 -0
- package/src/lib/components/number-input/pdx-number-input.json-api.md +594 -0
- package/src/lib/components/password-input/pdx-password-input.json-api.md +574 -0
- package/src/lib/components/pdx-material-time-range/pdx-material-time-range.json-api.md +592 -0
- package/src/lib/components/pdx-year-input/pdx-year-input.json-api.md +543 -0
- package/src/lib/components/phone-input/pdx-phone-input.json-api.md +583 -0
- package/src/lib/components/preload-status/pdx-preload-status.json-api.md +455 -0
- package/src/lib/components/search-input/pdx-search-input.json-api.md +536 -0
- package/src/lib/components/text-input/pdx-text-input.json-api.md +600 -0
- package/src/lib/components/time-input/pdx-time-input.json-api.md +546 -0
- package/src/lib/components/url-input/pdx-url-input.json-api.md +542 -0
- package/src/lib/components/week-input/pdx-week-input.json-api.md +533 -0
- package/{index.d.ts → types/praxisui-dynamic-fields.d.ts} +848 -445
- package/fesm2022/praxisui-dynamic-fields-index-C9IUU4lo.mjs +0 -1
- package/fesm2022/praxisui-dynamic-fields-index-GJtthzkD.mjs +0 -1
- package/fesm2022/praxisui-dynamic-fields-index-XvVS6lAQ.mjs +0 -1
- package/fesm2022/praxisui-dynamic-fields-index-iIeaA6ko.mjs +0 -1
|
@@ -0,0 +1,522 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "pdx-material-slide-toggle JSON API (Canonical)"
|
|
3
|
+
slug: "pdx-material-slide-toggle-json-api"
|
|
4
|
+
doc_type: "api-reference"
|
|
5
|
+
component: "pdx-material-slide-toggle"
|
|
6
|
+
document_kind: "json-api-canonical"
|
|
7
|
+
reference_mode: "canonical"
|
|
8
|
+
contract_format: "json"
|
|
9
|
+
contract_source: "runtime-and-code"
|
|
10
|
+
description: "Referencia canonica do contrato JSON do componente pdx-material-slide-toggle."
|
|
11
|
+
category: "components"
|
|
12
|
+
sub_category: "dynamic-fields"
|
|
13
|
+
audience:
|
|
14
|
+
- "frontend"
|
|
15
|
+
- "architect"
|
|
16
|
+
- "platform-team"
|
|
17
|
+
level: "advanced"
|
|
18
|
+
status: "active"
|
|
19
|
+
owner: "praxis-ui"
|
|
20
|
+
source_of_truth:
|
|
21
|
+
- "projects/praxis-dynamic-fields/src/lib/components/material-slide-toggle/material-slide-toggle.metadata.ts"
|
|
22
|
+
- "projects/praxis-dynamic-fields/src/lib/components/material-slide-toggle/material-slide-toggle.component.ts"
|
|
23
|
+
- "projects/praxis-dynamic-fields/src/lib/base/simple-base-input.component.ts"
|
|
24
|
+
- "projects/praxis-core/src/lib/models/material-field-metadata.interface.ts"
|
|
25
|
+
source_of_truth_last_verified: "2026-04-27"
|
|
26
|
+
last_updated: "2026-04-27"
|
|
27
|
+
toc: true
|
|
28
|
+
sidebar: true
|
|
29
|
+
tags:
|
|
30
|
+
- "json-api"
|
|
31
|
+
- "canonical-contract"
|
|
32
|
+
- "pdx-material-slide-toggle"
|
|
33
|
+
api_stability: "canonical"
|
|
34
|
+
schema_verified: true
|
|
35
|
+
runtime_verified: true
|
|
36
|
+
editor_coverage_verified: false
|
|
37
|
+
runtime_scope: "public"
|
|
38
|
+
legacy_paths_present: false
|
|
39
|
+
has_known_mismatches: false
|
|
40
|
+
related_components:
|
|
41
|
+
- "praxis-table"
|
|
42
|
+
- "pdx-base-input-runtime-contract"
|
|
43
|
+
- "pdx-material-slider"
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
# pdx-material-slide-toggle
|
|
47
|
+
|
|
48
|
+
Este documento e a referencia canonica da API JSON de pdx-material-slide-toggle.
|
|
49
|
+
|
|
50
|
+
## Summary
|
|
51
|
+
|
|
52
|
+
- Tipo documental: API reference canonica de contrato JSON.
|
|
53
|
+
- Source of truth: runtime e codigo declarados no frontmatter.
|
|
54
|
+
- Objetivo operacional: consulta rapida, auditavel e deterministica sob pressao.
|
|
55
|
+
- Resumo funcional: Contrato JSON metadata-driven com comportamento definido por runtime e schema associado.
|
|
56
|
+
|
|
57
|
+
## Purpose and scope
|
|
58
|
+
|
|
59
|
+
- O componente consome payload JSON metadata-driven e expoe comportamento runtime configuravel por contrato.
|
|
60
|
+
- Esta referencia cobre contrato publico, classificacao de paths e semantica de cobertura (runtime/schema/editor).
|
|
61
|
+
- Fora de escopo: quickstart, tutorial narrativo e notas arquiteturais que nao alteram contrato publico.
|
|
62
|
+
|
|
63
|
+
## Consulta rapida (obrigatorio)
|
|
64
|
+
|
|
65
|
+
| Regra/tema | Observado | Canonico desejado | Status | Evidencia |
|
|
66
|
+
| --- | --- | --- | --- | --- |
|
|
67
|
+
| Component id | `pdx-material-slide-toggle` | Manter ID canonico estavel e versionado por contrato | Active | frontmatter.component |
|
|
68
|
+
| Primary contract source | `runtime-and-code` | Runtime, schema e docs devem permanecer rastreaveis | Partial | frontmatter.contract_source + source_of_truth |
|
|
69
|
+
| Runtime coverage | `true` | Comportamentos runtime criticos devem ficar explicitamente verificados | Active | `projects/praxis-dynamic-fields/src/lib/components/material-slide-toggle/material-slide-toggle.component.ts`, focused component specs on 2026-04-27 |
|
|
70
|
+
| Schema/type coverage | `true` | Tipos e schema devem refletir paths publicos do contrato | Active | source_of_truth + Detailed API reference |
|
|
71
|
+
| Editor/tooling coverage | `false` | Editor/tooling deve espelhar somente contrato publico suportado | Partial | `projects/praxis-core/src/lib/metadata/field-selector-control-type.constants.ts`, `projects/praxis-dynamic-fields/src/lib/services/component-registry/component-registry.service.ts` |
|
|
72
|
+
| Legacy paths | `false` | Segregar legado de caminhos canonicos com janela de migracao | Active | frontmatter.legacy_paths_present |
|
|
73
|
+
| Known mismatches | `false` | Registrar observed vs desired de forma auditavel | Active | frontmatter.has_known_mismatches |
|
|
74
|
+
|
|
75
|
+
## Source of truth
|
|
76
|
+
|
|
77
|
+
| Source | Kind | Notes |
|
|
78
|
+
| --- | --- | --- |
|
|
79
|
+
| projects/praxis-dynamic-fields/src/lib/components/material-slide-toggle/material-slide-toggle.metadata.ts | schema-metadata | Arquivo presente no repositorio e usado como evidencia de contrato. |
|
|
80
|
+
| projects/praxis-dynamic-fields/src/lib/components/material-slide-toggle/material-slide-toggle.component.ts | runtime-code | Arquivo presente no repositorio e usado como evidencia de contrato. |
|
|
81
|
+
| projects/praxis-dynamic-fields/src/lib/base/simple-base-input.component.ts | runtime-code | Arquivo presente no repositorio e usado como evidencia de contrato. |
|
|
82
|
+
| projects/praxis-core/src/lib/models/material-field-metadata.interface.ts | schema-types | Arquivo presente no repositorio e usado como evidencia de contrato. |
|
|
83
|
+
|
|
84
|
+
## Support legend
|
|
85
|
+
|
|
86
|
+
- **Active**: suportado em runtime e liberado para uso externo.
|
|
87
|
+
- **Partial**: suporte parcial, com restricoes, lacunas ou validacao incompleta.
|
|
88
|
+
- **Declared-only**: declarado em tipos/schema sem evidencia operacional completa.
|
|
89
|
+
- **Schema-only**: presente em schema/tipos sem cobertura runtime confirmada.
|
|
90
|
+
- **Deprecated**: legado suportado por janela de migracao definida.
|
|
91
|
+
|
|
92
|
+
## Contract status snapshot
|
|
93
|
+
|
|
94
|
+
| Item | Value | Notes |
|
|
95
|
+
| --- | --- | --- |
|
|
96
|
+
| Reference mode | `canonical` | Deve permanecer canonico |
|
|
97
|
+
| Contract format | `json` | Contrato metadata-driven |
|
|
98
|
+
| Contract source | `runtime-and-code` | Alinhar com source_of_truth |
|
|
99
|
+
| Runtime scope | `public` | Escopo publicado para consumidores |
|
|
100
|
+
| Runtime verified | `true` | Revisar sempre com evidencia de runtime |
|
|
101
|
+
| Schema verified | `true` | Revisar sempre com evidencia de tipos/schema |
|
|
102
|
+
| Editor coverage verified | `false` | Revisar sempre com evidencia de editor/tooling |
|
|
103
|
+
| Legacy paths present | `false` | Segregar legado de contrato canonico |
|
|
104
|
+
| Has known mismatches | `false` | Divergencias devem aparecer em secao dedicada |
|
|
105
|
+
|
|
106
|
+
## Contract classification (obrigatorio)
|
|
107
|
+
|
|
108
|
+
### Canonical paths (public contract)
|
|
109
|
+
|
|
110
|
+
| Path | Type | Required | Default | Status | Notes |
|
|
111
|
+
| --- | --- | --- | --- | --- | --- |
|
|
112
|
+
| `metadata` | object | true | n/a | Active | See Detailed API reference for runtime semantics. |
|
|
113
|
+
| `readonlyMode` | boolean | false | `false` | Active | Blocks switch interaction and exposes `aria-readonly`. |
|
|
114
|
+
| `disabledMode` | boolean | false | `false` | Active | Blocks switch interaction and exposes disabled styling/ARIA. |
|
|
115
|
+
| `visible` | boolean | false | `true` | Active | Hides the host and marks it `aria-hidden`. |
|
|
116
|
+
| `presentationMode` | boolean | false | `false` | Active | Blocks switch interaction as readonly presentation output. |
|
|
117
|
+
| `metadata.controlType` | string | false | n/a | Active | Runtime selector/type for this control. |
|
|
118
|
+
| `metadata.color` | string | false | n/a | Active | Material theme color passed to the switch. |
|
|
119
|
+
| `metadata.labelPosition` | string | false | `after` | Active | Label position in relation to the switch. |
|
|
120
|
+
|
|
121
|
+
### Supported legacy paths
|
|
122
|
+
|
|
123
|
+
Nenhum path legado suportado foi identificado nesta revisao.
|
|
124
|
+
|
|
125
|
+
### Internal-only paths
|
|
126
|
+
|
|
127
|
+
Nao ha paths internal-only confirmados no contrato publico desta revisao.
|
|
128
|
+
|
|
129
|
+
### Experimental paths
|
|
130
|
+
|
|
131
|
+
Nao ha paths experimentais confirmados no contrato publico desta revisao.
|
|
132
|
+
|
|
133
|
+
## Public contract surface (obrigatorio)
|
|
134
|
+
|
|
135
|
+
### Top-level configuration blocks
|
|
136
|
+
|
|
137
|
+
| Block | Purpose | Required | Merge strategy | Notes |
|
|
138
|
+
| --- | --- | --- | --- | --- |
|
|
139
|
+
| `metadata` | Payload declarativo principal do componente | true | deep-merge | runtime linkage verified for core flows (component specs, 2026-04-27). |
|
|
140
|
+
| `readonlyMode` | Override de readonly no host/runtime | false | override | disables interaction and exposes readonly semantics (component specs, 2026-04-27). |
|
|
141
|
+
| `disabledMode` | Override de disabled no host/runtime | false | override | disables interaction and exposes disabled semantics (component specs, 2026-04-27). |
|
|
142
|
+
| `visible` | Override de visibilidade no host/runtime | false | override | host visibility binding remains active. |
|
|
143
|
+
| `presentationMode` | Renderizacao de apresentacao sem interacao | false | override | disables interaction and exposes readonly semantics (component specs, 2026-04-27). |
|
|
144
|
+
| `Validators` | Configuracao especifica de runtime | false | override | `requiredTrue` is added and removed according to current metadata (component specs, 2026-04-27). |
|
|
145
|
+
|
|
146
|
+
### Nested configuration blocks
|
|
147
|
+
|
|
148
|
+
| Path | Type | Required | Default | Constraints | Notes |
|
|
149
|
+
| --- | --- | --- | --- | --- | --- |
|
|
150
|
+
| `metadata.controlType` | string | false | n/a | component-defined | Active; selects the slide-toggle renderer. |
|
|
151
|
+
| `metadata.color` | string | false | n/a | component-defined | Active; passed to Material slide toggle. |
|
|
152
|
+
| `metadata.labelPosition` | string | false | `after` | component-defined | Active; controls label position. |
|
|
153
|
+
| `metadata.disableRipple` | boolean | false | n/a | component-defined | Active; passed to Material slide toggle. |
|
|
154
|
+
| `metadata.hideIcon` | boolean | false | n/a | component-defined | Active; passed to Material slide toggle. |
|
|
155
|
+
| `metadata.required` | boolean | false | n/a | component-defined | Active; marks the switch as required. |
|
|
156
|
+
| `metadata.requiredTrue` | boolean | false | n/a | component-defined | Active; applies `Validators.requiredTrue` and marks ARIA required. |
|
|
157
|
+
| `Validators.requiredTrue` | boolean | false | n/a | component-defined | Active; validator is removed when metadata no longer declares it. |
|
|
158
|
+
| `metadata.readonly` | boolean | false | n/a | component-defined | Active; blocks switch interaction and exposes `aria-readonly`. |
|
|
159
|
+
|
|
160
|
+
### Input bindings (inbound data)
|
|
161
|
+
|
|
162
|
+
| Binding/Path | Type | Required | Source | Runtime normalization | Notes |
|
|
163
|
+
| --- | --- | --- | --- | --- | --- |
|
|
164
|
+
| `metadata` | object | true | host-json | component-defined | Primary inbound contract payload. |
|
|
165
|
+
| `readonlyMode` | boolean | false | host-runtime | effective boolean | Host-level behavioral override that blocks interaction and exposes readonly semantics. |
|
|
166
|
+
| `disabledMode` | boolean | false | host-runtime | effective boolean | Host-level behavioral override that blocks interaction and exposes disabled semantics. |
|
|
167
|
+
| `visible` | boolean | false | host-runtime | effective boolean | Host-level visibility override. |
|
|
168
|
+
| `presentationMode` | boolean | false | host-runtime | effective boolean | Host-level presentation override that blocks interaction as readonly output. |
|
|
169
|
+
|
|
170
|
+
### Output events
|
|
171
|
+
|
|
172
|
+
| Event | Payload | Trigger | Stability | Notes |
|
|
173
|
+
| --- | --- | --- | --- | --- |
|
|
174
|
+
| `valueChange` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
|
|
175
|
+
| `focusChange` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
|
|
176
|
+
| `nativeBlur` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
|
|
177
|
+
| `nativeChange` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
|
|
178
|
+
|
|
179
|
+
### External side channels
|
|
180
|
+
|
|
181
|
+
| Channel | Direction | Contract | Failure mode | Notes |
|
|
182
|
+
| --- | --- | --- | --- | --- |
|
|
183
|
+
| `host/services/storage` | bidirectional | component-defined | component-defined | Side channels variam por componente e host; verificar em source_of_truth. |
|
|
184
|
+
|
|
185
|
+
### Host/runtime dependencies
|
|
186
|
+
|
|
187
|
+
| Dependency | Required | Environment | Purpose | Notes |
|
|
188
|
+
| --- | --- | --- | --- | --- |
|
|
189
|
+
| `material-slide-toggle.metadata.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/components/material-slide-toggle/material-slide-toggle.metadata.ts`. |
|
|
190
|
+
| `material-slide-toggle.component.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/components/material-slide-toggle/material-slide-toggle.component.ts`. |
|
|
191
|
+
| `simple-base-input.component.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/base/simple-base-input.component.ts`. |
|
|
192
|
+
| `material-field-metadata.interface.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-core/src/lib/models/material-field-metadata.interface.ts`. |
|
|
193
|
+
|
|
194
|
+
## Coverage by surface (obrigatorio)
|
|
195
|
+
|
|
196
|
+
### Coverage matrix (runtime, schema/type, editor/tooling)
|
|
197
|
+
|
|
198
|
+
| Surface | Verified | Coverage status | Evidence | Notes |
|
|
199
|
+
| --- | --- | --- | --- | --- |
|
|
200
|
+
| Runtime | `true` | Active | `projects/praxis-dynamic-fields/src/lib/components/material-slide-toggle/material-slide-toggle.component.ts`, focused component specs | Core runtime flows verified via focused component specs on 2026-04-27; editor/tooling coverage remains independent. |
|
|
201
|
+
| Schema/Types | `true` | Active | source_of_truth + Detailed API reference | Reconcile schema/types with canonical paths during follow-up when needed. |
|
|
202
|
+
| Editor/Tooling | `false` | Partial | `projects/praxis-core/src/lib/metadata/field-selector-control-type.constants.ts`, `projects/praxis-dynamic-fields/src/lib/services/component-registry/component-registry.service.ts` | Selector/control-type tooling linkage verified via default selector map and registry seeding; visual editor end-to-end coverage remains not-yet-verified. |
|
|
203
|
+
|
|
204
|
+
### Runtime coverage boundaries
|
|
205
|
+
|
|
206
|
+
- Ambientes suportados: browser/dev/prod; SSR/hydration appears to be component-dependent unless explicitly verified.
|
|
207
|
+
- Pre-condicoes: payload JSON valido, bindings de host consistentes e dependencias descritas no source_of_truth.
|
|
208
|
+
- Fora de cobertura confirmada: caminhos internos, experimentais ou aliases nao enumerados formalmente.
|
|
209
|
+
|
|
210
|
+
### Editor and tooling notes
|
|
211
|
+
|
|
212
|
+
- Evidencia de tooling: selector `pdx-*` mapeado em `DEFAULT_FIELD_SELECTOR_CONTROL_TYPE_MAP` e semeado no `ComponentRegistryService`; editor visual E2E permanece not-yet-verified.
|
|
213
|
+
- O que esta exposto no editor visual depende da cobertura real do workspace e nao deve ser inferido como suporte runtime total.
|
|
214
|
+
- Campos disponiveis apenas via JSON/manual devem continuar no contrato, com rotulo explicito de cobertura parcial.
|
|
215
|
+
- Quando houver divergencia entre editor e runtime, manter mismatch rastreavel em secao dedicada.
|
|
216
|
+
|
|
217
|
+
## Resolution and precedence model (obrigatorio)
|
|
218
|
+
|
|
219
|
+
### Merge order
|
|
220
|
+
|
|
221
|
+
1. defaults do componente
|
|
222
|
+
2. contrato JSON recebido
|
|
223
|
+
3. overrides de host/runtime
|
|
224
|
+
4. normalizacoes internas
|
|
225
|
+
|
|
226
|
+
### Fallback order
|
|
227
|
+
|
|
228
|
+
contrato explicito -> aliases legados (quando suportados) -> defaults internos -> comportamento seguro
|
|
229
|
+
|
|
230
|
+
### Override points
|
|
231
|
+
|
|
232
|
+
- inputs publicos do componente
|
|
233
|
+
- configuracao JSON de runtime
|
|
234
|
+
- integracoes de host (servicos/tokens/adapters)
|
|
235
|
+
|
|
236
|
+
### Runtime normalization
|
|
237
|
+
|
|
238
|
+
Alias e defaults devem convergir para paths canonicos; onde nao houver evidencia, manter not-yet-verified de forma explicita.
|
|
239
|
+
|
|
240
|
+
### Precedence rules
|
|
241
|
+
|
|
242
|
+
Em conflito entre alias legado e path canonico, priorizar path canonico e registrar janela de migracao do legado.
|
|
243
|
+
|
|
244
|
+
## Validation and error semantics (obrigatorio)
|
|
245
|
+
|
|
246
|
+
### Validation model
|
|
247
|
+
|
|
248
|
+
| Path/Rule | Validation phase | Behavior on fail | Error code / warning | Notes |
|
|
249
|
+
| --- | --- | --- | --- | --- |
|
|
250
|
+
| canonical-paths | parse/runtime | component-defined (warn/reject/default) | not-yet-standardized | Semantica detalhada preservada na referencia tecnica por componente. |
|
|
251
|
+
|
|
252
|
+
### Invalid and unknown field handling
|
|
253
|
+
|
|
254
|
+
- Campos desconhecidos: comportamento component-defined (ignore, warn ou reject).
|
|
255
|
+
- Tipos invalidos: pode haver fallback, warning ou falha, conforme runtime especifico.
|
|
256
|
+
- Valores fora de dominio: registrar observed vs desired em Known limitations and mismatches.
|
|
257
|
+
|
|
258
|
+
### Fail-open / fail-closed behavior
|
|
259
|
+
|
|
260
|
+
| Condition | Mode | Runtime behavior | Consumer impact |
|
|
261
|
+
| --- | --- | --- | --- |
|
|
262
|
+
| invalid-or-unknown-field | component-defined | not-yet-verified | Pode gerar warning, fallback silencioso ou rejeicao; validar por componente. |
|
|
263
|
+
|
|
264
|
+
### Runtime warnings vs hard failures
|
|
265
|
+
|
|
266
|
+
| Condition | Severity | Observability | Consumer action |
|
|
267
|
+
| --- | --- | --- | --- |
|
|
268
|
+
| partial-or-declared-only-coverage | warning | logs/eventos do componente | Confirmar ligacao runtime antes de uso critico. |
|
|
269
|
+
| mismatch-confirmed | error-or-warning | componente/host observability | Planejar migracao e corrigir contrato/runtime. |
|
|
270
|
+
|
|
271
|
+
## Detailed API reference
|
|
272
|
+
### Preserved technical reference (normalized from previous revision)
|
|
273
|
+
|
|
274
|
+
### 1. Visao Geral e Quando Usar
|
|
275
|
+
`pdx-material-slide-toggle` e o alternador booleano Material baseado em JSON.
|
|
276
|
+
|
|
277
|
+
Use quando precisar:
|
|
278
|
+
- ativar/desativar flags booleanas;
|
|
279
|
+
- aplicar regra `requiredTrue` em aceite/confirmacao;
|
|
280
|
+
- manter UX compacta para preferencias e features.
|
|
281
|
+
|
|
282
|
+
### 2. API do Componente (Inputs/Outputs)
|
|
283
|
+
| Propriedade | Tipo | Padrao | Obrigatorio | Comportamento |
|
|
284
|
+
| --- | --- | --- | --- | --- |
|
|
285
|
+
| `metadata` | `MaterialToggleMetadata` | - | Sim | Contrato principal do toggle. |
|
|
286
|
+
| `readonlyMode` | `boolean` | `false` | Nao | Sobrescreve leitura no host. |
|
|
287
|
+
| `disabledMode` | `boolean` | `false` | Nao | Sobrescreve disabled no host. |
|
|
288
|
+
| `visible` | `boolean` | `true` | Nao | Controla exibicao no host. |
|
|
289
|
+
| `presentationMode` | `boolean` | `false` | Nao | Modo apresentacao sem edicao. |
|
|
290
|
+
| `valueChange` | `boolean` | - | Output base input | Mudanca do estado on/off. |
|
|
291
|
+
|
|
292
|
+
### 3. Matriz de Cobertura JSON (Completa)
|
|
293
|
+
#### 3.1 Campos especificos do componente
|
|
294
|
+
| Caminho JSON | Tipo | Status | Comportamento em runtime |
|
|
295
|
+
| --- | --- | --- | --- |
|
|
296
|
+
| `metadata.controlType` | `'toggle'` | Ativo | Define renderer de slide toggle. |
|
|
297
|
+
| `metadata.color` | `ThemePalette` | Ativo | Cor Material do toggle. |
|
|
298
|
+
| `metadata.labelPosition` | `'before' \| 'after'` | Ativo | Posicao do label em relacao ao switch. |
|
|
299
|
+
| `metadata.disableRipple` | `boolean` | Ativo | Desativa efeito ripple no toggle. |
|
|
300
|
+
| `metadata.hideIcon` | `boolean` | Ativo | Oculta icone interno do thumb. |
|
|
301
|
+
| `metadata.required` | `boolean` | Ativo | Marca requisito no controle e ARIA. |
|
|
302
|
+
| `metadata.requiredTrue` | `boolean` | Ativo | Adiciona `Validators.requiredTrue`. |
|
|
303
|
+
| `metadata.readonly` | `boolean` | Ativo | Bloqueia interacao no switch e expoe `aria-readonly`. |
|
|
304
|
+
|
|
305
|
+
#### 3.2 Campos herdados compartilhados (exaustivo)
|
|
306
|
+
Contrato compartilhado de input base:
|
|
307
|
+
- [pdx-base-input-runtime-contract.json-api.md](projects/praxis-dynamic-fields/src/lib/base/pdx-base-input-runtime-contract.json-api.md)
|
|
308
|
+
|
|
309
|
+
Resumo de composicao deste componente:
|
|
310
|
+
- `Ativo`: configuracao visual, estados governados e regra de `requiredTrue`.
|
|
311
|
+
- `Parcial`: editor visual E2E permanece independente da cobertura runtime deste componente.
|
|
312
|
+
|
|
313
|
+
### 4. Mapeamento de Comportamento
|
|
314
|
+
- Valor: booleano ligado ao `FormControl`.
|
|
315
|
+
- Validacao: `requiredTrue` aplicavel para termos/aceite obrigatorio.
|
|
316
|
+
- Acessibilidade: nome acessivel, `aria-required`, `aria-invalid`, `aria-disabled` e `aria-readonly` no host/toggle.
|
|
317
|
+
- Erros/hints: pipeline padrao do base input.
|
|
318
|
+
|
|
319
|
+
### 5. Exemplo Minimo (JSON + Uso)
|
|
320
|
+
```json
|
|
321
|
+
{
|
|
322
|
+
"componentId": "pdx-material-slide-toggle",
|
|
323
|
+
"metadata": {
|
|
324
|
+
"name": "active",
|
|
325
|
+
"label": "Ativo",
|
|
326
|
+
"controlType": "toggle"
|
|
327
|
+
}
|
|
328
|
+
}
|
|
329
|
+
```
|
|
330
|
+
Uso: ativa/desativa uma flag booleana simples.
|
|
331
|
+
|
|
332
|
+
### 6. Exemplo Corporativo (JSON + Uso)
|
|
333
|
+
```json
|
|
334
|
+
{
|
|
335
|
+
"componentId": "pdx-material-slide-toggle",
|
|
336
|
+
"metadata": {
|
|
337
|
+
"name": "acceptPolicy",
|
|
338
|
+
"label": "Aceito a politica corporativa",
|
|
339
|
+
"controlType": "toggle",
|
|
340
|
+
"required": true,
|
|
341
|
+
"requiredTrue": true,
|
|
342
|
+
"color": "primary",
|
|
343
|
+
"labelPosition": "after",
|
|
344
|
+
"disableRipple": false,
|
|
345
|
+
"hideIcon": false,
|
|
346
|
+
"hint": "Obrigatorio para concluir o cadastro."
|
|
347
|
+
}
|
|
348
|
+
}
|
|
349
|
+
```
|
|
350
|
+
Uso: aceite obrigatorio de politica com validacao de verdadeiro.
|
|
351
|
+
|
|
352
|
+
### 7. Troubleshooting e Armadilhas Comuns
|
|
353
|
+
1. Campo obrigatorio passa com valor `false`.
|
|
354
|
+
Correcao: usar `requiredTrue=true` em vez de apenas `required`.
|
|
355
|
+
|
|
356
|
+
2. Esperar bloqueio editavel com `readonly=true`.
|
|
357
|
+
Correcao: `readonly=true`, `readonlyMode=true` e `presentationMode=true` bloqueiam interacao e mantem semantica readonly.
|
|
358
|
+
|
|
359
|
+
3. Ripple nao desliga.
|
|
360
|
+
Correcao: validar `disableRipple=true` no metadata final aplicado.
|
|
361
|
+
|
|
362
|
+
4. Icone interno continua visivel.
|
|
363
|
+
Correcao: conferir versao de Material e `hideIcon=true` no payload.
|
|
364
|
+
|
|
365
|
+
5. Estado nao persiste.
|
|
366
|
+
Correcao: verificar binding do form control e serializacao booleana no host.
|
|
367
|
+
|
|
368
|
+
### 8. Cross-links
|
|
369
|
+
- `projects/praxis-dynamic-fields/src/lib/base/pdx-base-input-runtime-contract.json-api.md`
|
|
370
|
+
- `projects/praxis-dynamic-fields/src/lib/components/material-slider/pdx-material-slider.json-api.md`
|
|
371
|
+
|
|
372
|
+
### 9. Relatorio de Validacao Estrutural
|
|
373
|
+
- Visao geral: PASS
|
|
374
|
+
- API (inputs/outputs): PASS
|
|
375
|
+
- Cobertura JSON completa (especifico + herdado): PASS
|
|
376
|
+
- Mapeamento de comportamento: PASS
|
|
377
|
+
- Exemplo minimo: PASS
|
|
378
|
+
- Exemplo corporativo: PASS
|
|
379
|
+
- Troubleshooting: PASS
|
|
380
|
+
|
|
381
|
+
## JSON path index (obrigatorio)
|
|
382
|
+
|
|
383
|
+
| Path | Type | Required | Default | Status | Notes |
|
|
384
|
+
| --- | --- | --- | --- | --- | --- |
|
|
385
|
+
| `metadata` | object | true | n/a | Active | See Detailed API reference. |
|
|
386
|
+
| `readonlyMode` | boolean | false | `false` | Active | See Detailed API reference. |
|
|
387
|
+
| `disabledMode` | boolean | false | `false` | Active | See Detailed API reference. |
|
|
388
|
+
| `visible` | boolean | false | `true` | Active | See Detailed API reference. |
|
|
389
|
+
| `presentationMode` | boolean | false | `false` | Active | See Detailed API reference. |
|
|
390
|
+
| `metadata.controlType` | string | false | n/a | Active | See Detailed API reference. |
|
|
391
|
+
| `metadata.color` | string | false | n/a | Active | See Detailed API reference. |
|
|
392
|
+
| `metadata.labelPosition` | string | false | `after` | Active | See Detailed API reference. |
|
|
393
|
+
| `metadata.disableRipple` | boolean | false | n/a | Active | See Detailed API reference. |
|
|
394
|
+
| `metadata.hideIcon` | boolean | false | n/a | Active | See Detailed API reference. |
|
|
395
|
+
| `metadata.required` | boolean | false | n/a | Active | See Detailed API reference. |
|
|
396
|
+
| `metadata.requiredTrue` | boolean | false | n/a | Active | See Detailed API reference. |
|
|
397
|
+
| `Validators.requiredTrue` | boolean | false | n/a | Active | See Detailed API reference. |
|
|
398
|
+
| `metadata.readonly` | boolean | false | n/a | Active | See Detailed API reference. |
|
|
399
|
+
|
|
400
|
+
## Events reference (obrigatorio)
|
|
401
|
+
|
|
402
|
+
| Event | Payload | Trigger | Stability | Notes |
|
|
403
|
+
| --- | --- | --- | --- | --- |
|
|
404
|
+
| `valueChange` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
|
|
405
|
+
| `focusChange` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
|
|
406
|
+
| `nativeBlur` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
|
|
407
|
+
| `nativeChange` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
|
|
408
|
+
|
|
409
|
+
## Styling API (obrigatorio quando aplicavel)
|
|
410
|
+
|
|
411
|
+
| Token/Class | Scope | Purpose | Notes |
|
|
412
|
+
| --- | --- | --- | --- |
|
|
413
|
+
| `metadata.color` | component | Styling-related JSON path | Validate against runtime implementation. |
|
|
414
|
+
| `metadata.hideIcon` | component | Styling-related JSON path | Validate against runtime implementation. |
|
|
415
|
+
|
|
416
|
+
## Examples (obrigatorio)
|
|
417
|
+
|
|
418
|
+
| Example | Scenario | Validates | Notes |
|
|
419
|
+
| --- | --- | --- | --- |
|
|
420
|
+
| `Minimal valid` | baseline payload | required contract blocks | Extracted from preserved technical reference when available. |
|
|
421
|
+
| `Common setup` | common component usage | standard runtime behavior | Validate against host integration path. |
|
|
422
|
+
| `Advanced setup` | richer config with overrides | precedence and normalization | Requires runtime confirmation for edge cases. |
|
|
423
|
+
| `Enterprise scenario` | governance/legacy/migration context | auditability and compatibility boundaries | Include tenant-specific constraints when applicable. |
|
|
424
|
+
|
|
425
|
+
### Minimal valid
|
|
426
|
+
|
|
427
|
+
```json
|
|
428
|
+
{
|
|
429
|
+
"componentId": "pdx-material-slide-toggle",
|
|
430
|
+
"metadata": {
|
|
431
|
+
"name": "active",
|
|
432
|
+
"label": "Ativo",
|
|
433
|
+
"controlType": "toggle"
|
|
434
|
+
},
|
|
435
|
+
"readonlyMode": false
|
|
436
|
+
}
|
|
437
|
+
```
|
|
438
|
+
|
|
439
|
+
### Common setup
|
|
440
|
+
|
|
441
|
+
```json
|
|
442
|
+
{
|
|
443
|
+
"componentId": "pdx-material-slide-toggle",
|
|
444
|
+
"metadata": {
|
|
445
|
+
"name": "acceptPolicy",
|
|
446
|
+
"label": "Aceito a politica corporativa",
|
|
447
|
+
"controlType": "pdx-material-slide-toggle-common",
|
|
448
|
+
"required": true,
|
|
449
|
+
"requiredTrue": true,
|
|
450
|
+
"color": "primary",
|
|
451
|
+
"labelPosition": "after",
|
|
452
|
+
"disableRipple": false,
|
|
453
|
+
"hideIcon": false,
|
|
454
|
+
"hint": "Obrigatorio para concluir o cadastro."
|
|
455
|
+
}
|
|
456
|
+
}
|
|
457
|
+
```
|
|
458
|
+
|
|
459
|
+
### Advanced setup
|
|
460
|
+
|
|
461
|
+
```json
|
|
462
|
+
{
|
|
463
|
+
"componentId": "pdx-material-slide-toggle",
|
|
464
|
+
"metadata": {
|
|
465
|
+
"name": "acceptPolicy",
|
|
466
|
+
"label": "Aceito a politica corporativa",
|
|
467
|
+
"controlType": "toggle",
|
|
468
|
+
"required": true,
|
|
469
|
+
"requiredTrue": true,
|
|
470
|
+
"color": "primary",
|
|
471
|
+
"labelPosition": "after",
|
|
472
|
+
"disableRipple": false,
|
|
473
|
+
"hideIcon": false,
|
|
474
|
+
"hint": "Obrigatorio para concluir o cadastro."
|
|
475
|
+
},
|
|
476
|
+
"readonlyMode": false,
|
|
477
|
+
"disabledMode": false
|
|
478
|
+
}
|
|
479
|
+
```
|
|
480
|
+
|
|
481
|
+
### Enterprise scenario
|
|
482
|
+
|
|
483
|
+
```json
|
|
484
|
+
{
|
|
485
|
+
"componentId": "pdx-material-slide-toggle",
|
|
486
|
+
"metadata": {
|
|
487
|
+
"name": "acceptPolicy",
|
|
488
|
+
"label": "Aceito a politica corporativa",
|
|
489
|
+
"controlType": "toggle",
|
|
490
|
+
"required": true,
|
|
491
|
+
"requiredTrue": true,
|
|
492
|
+
"color": "primary",
|
|
493
|
+
"labelPosition": "after",
|
|
494
|
+
"disableRipple": false,
|
|
495
|
+
"hideIcon": false,
|
|
496
|
+
"hint": "Obrigatorio para concluir o cadastro."
|
|
497
|
+
},
|
|
498
|
+
"presentationMode": true,
|
|
499
|
+
"visible": true
|
|
500
|
+
}
|
|
501
|
+
```
|
|
502
|
+
|
|
503
|
+
## Compatibility and migration notes (recomendado)
|
|
504
|
+
|
|
505
|
+
| Concern | Affected versions | Migration action | Deadline | Notes |
|
|
506
|
+
| --- | --- | --- | --- | --- |
|
|
507
|
+
| No legacy path detected in current revision | n/a | No migration action required for canonical paths | n/a | Re-evaluate if backward-compat aliases are introduced |
|
|
508
|
+
|
|
509
|
+
## Known limitations and mismatches (recomendado)
|
|
510
|
+
|
|
511
|
+
| Path/Behavior | Observed behavior (runtime) | Desired behavior | Impact | Tracking issue | Target fix |
|
|
512
|
+
| --- | --- | --- | --- | --- | --- |
|
|
513
|
+
| Canonical contract parity | No confirmed mismatch in this revision; runtime linkage verified for core flows (2026-04-27), with editor/tooling coverage pending | Keep runtime/schema/editor alignment evidence updated | Low | n/a | Monitor in periodic audit |
|
|
514
|
+
|
|
515
|
+
## Source references (obrigatorio)
|
|
516
|
+
|
|
517
|
+
| Source type | Path/URL | Why it is source of truth | Last verified (YYYY-MM-DD) | Notes |
|
|
518
|
+
| --- | --- | --- | --- | --- |
|
|
519
|
+
| schema-metadata | projects/praxis-dynamic-fields/src/lib/components/material-slide-toggle/material-slide-toggle.metadata.ts | Primary source of truth for contract and behavior. | 2026-04-27 | verified-path |
|
|
520
|
+
| runtime-code | projects/praxis-dynamic-fields/src/lib/components/material-slide-toggle/material-slide-toggle.component.ts | Primary source of truth for contract and behavior. | 2026-04-27 | verified-path |
|
|
521
|
+
| runtime-code | projects/praxis-dynamic-fields/src/lib/base/simple-base-input.component.ts | Primary source of truth for contract and behavior. | 2026-04-27 | verified-path |
|
|
522
|
+
| schema-types | projects/praxis-core/src/lib/models/material-field-metadata.interface.ts | Primary source of truth for contract and behavior. | 2026-04-27 | verified-path |
|