@praxisui/dynamic-fields 8.0.0-beta.6 → 8.0.0-beta.60

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