@praxisui/dynamic-fields 8.0.0-beta.7 → 8.0.0-beta.71

package/src/lib/components/inline-rating/pdx-inline-rating.json-api.md

@@ -0,0 +1,594 @@
+---
+title: "pdx-inline-rating JSON API (Canonical)"
+slug: "pdx-inline-rating-json-api"
+doc_type: "api-reference"
+component: "pdx-inline-rating"
+document_kind: "json-api-canonical"
+reference_mode: "canonical"
+contract_format: "json"
+contract_source: "runtime-and-code"
+description: "Referencia canonica do contrato JSON do componente pdx-inline-rating."
+category: "components"
+sub_category: "dynamic-fields"
+audience:
+  - "frontend"
+  - "architect"
+  - "platform-team"
+level: "advanced"
+status: "active"
+owner: "praxis-ui"
+source_of_truth:
+  - "projects/praxis-dynamic-fields/src/lib/components/inline-rating/inline-rating.component.ts"
+  - "projects/praxis-dynamic-fields/src/lib/components/inline-range-slider/inline-range-slider.component.ts"
+  - "projects/praxis-core/src/lib/models/material-field-metadata.interface.ts"
+source_of_truth_last_verified: "2026-03-06"
+last_updated: "2026-03-06"
+toc: true
+sidebar: true
+tags:
+  - "json-api"
+  - "canonical-contract"
+  - "pdx-inline-rating"
+api_stability: "canonical"
+schema_verified: true
+runtime_verified: true
+editor_coverage_verified: false
+runtime_scope: "public"
+legacy_paths_present: true
+has_known_mismatches: false
+related_components:
+  - "praxis-table"
+  - "pdx-inline-range-slider"
+  - "pdx-material-range-slider"
+---
+
+# pdx-inline-rating
+
+Este documento e a referencia canonica da API JSON de pdx-inline-rating.
+
+## Summary
+
+- Tipo documental: API reference canonica de contrato JSON.
+- Source of truth: runtime e codigo declarados no frontmatter.
+- Objetivo operacional: consulta rapida, auditavel e deterministica sob pressao.
+- Resumo funcional: Contrato JSON metadata-driven com comportamento definido por runtime e schema associado.
+
+## Purpose and scope
+
+- O componente consome payload JSON metadata-driven e expoe comportamento runtime configuravel por contrato.
+- Esta referencia cobre contrato publico, classificacao de paths e semantica de cobertura (runtime/schema/editor).
+- Fora de escopo: quickstart, tutorial narrativo e notas arquiteturais que nao alteram contrato publico.
+
+## Consulta rapida (obrigatorio)
+
+| Regra/tema | Observado | Canonico desejado | Status | Evidencia |
+| --- | --- | --- | --- | --- |
+| Component id | `pdx-inline-rating` | Manter ID canonico estavel e versionado por contrato | Active | frontmatter.component |
+| Primary contract source | `runtime-and-code` | Runtime, schema e docs devem permanecer rastreaveis | Partial | frontmatter.contract_source + source_of_truth |
+| Runtime coverage | `true` | Comportamentos runtime criticos devem ficar explicitamente verificados | Active | `projects/praxis-dynamic-fields/src/lib/components/inline-rating/inline-rating.component.ts`, `projects/praxis-dynamic-fields/src/lib/components/inline-range-slider/inline-range-slider.component.ts` |
+| Schema/type coverage | `true` | Tipos e schema devem refletir paths publicos do contrato | Active | source_of_truth + Detailed API reference |
+| 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` |
+| Path hygiene | `true` | Manter consistencia entre contrato canonico e caminhos documentados | Partial | frontmatter.legacy_paths_present |
+| Known mismatches | `false` | Registrar observed vs desired de forma auditavel | Active | frontmatter.has_known_mismatches |
+
+## Source of truth
+
+| Source | Kind | Notes |
+| --- | --- | --- |
+| projects/praxis-dynamic-fields/src/lib/components/inline-rating/inline-rating.component.ts | runtime-code | Arquivo presente no repositorio e usado como evidencia de contrato. |
+| projects/praxis-dynamic-fields/src/lib/components/inline-range-slider/inline-range-slider.component.ts | runtime-code | Arquivo presente no repositorio e usado como evidencia de contrato. |
+| projects/praxis-core/src/lib/models/material-field-metadata.interface.ts | schema-types | Arquivo presente no repositorio e usado como evidencia de contrato. |
+
+## Support legend
+
+- **Active**: suportado em runtime e liberado para uso externo.
+- **Partial**: suporte parcial, com restricoes, lacunas ou validacao incompleta.
+- **Declared-only**: declarado em tipos/schema sem evidencia operacional completa.
+- **Schema-only**: presente em schema/tipos sem cobertura runtime confirmada.
+
+## Contract status snapshot
+
+| Item | Value | Notes |
+| --- | --- | --- |
+| Reference mode | `canonical` | Deve permanecer canonico |
+| Contract format | `json` | Contrato metadata-driven |
+| Contract source | `runtime-and-code` | Alinhar com source_of_truth |
+| Runtime scope | `public` | Escopo publicado para consumidores |
+| Runtime verified | `true` | Revisar sempre com evidencia de runtime |
+| Schema verified | `true` | Revisar sempre com evidencia de tipos/schema |
+| Editor coverage verified | `false` | Revisar sempre com evidencia de editor/tooling |
+| Current path hygiene | `true` | Segregar consistencia do contrato canonico |
+| Has known mismatches | `false` | Divergencias devem aparecer em secao dedicada |
+
+## Contract classification (obrigatorio)
+
+### Canonical paths (public contract)
+
+| Path | Type | Required | Default | Status | Notes |
+| --- | --- | --- | --- | --- | --- |
+| `metadata` | object | true | n/a | Partial | See Detailed API reference for runtime semantics. |
+| `0.5` | unknown | false | n/a | Partial | See Detailed API reference for runtime semantics. |
+| `metadata.ratingIcon` | string | false | n/a | Partial | See Detailed API reference for runtime semantics. |
+| `metadata.prefixIcon` | string | false | n/a | Partial | See Detailed API reference for runtime semantics. |
+| `metadata.inlineAutoSize.*` | object | false | n/a | Partial | See Detailed API reference for runtime semantics. |
+| `metadata.quickPresets` | array | false | n/a | Partial | See Detailed API reference for runtime semantics. |
+| `readonlyMode` | boolean | false | n/a | Partial | See Detailed API reference for runtime semantics. |
+| `disabledMode` | boolean | false | n/a | Partial | See Detailed API reference for runtime semantics. |
+
+### Path audit
+
+| Historical path | Canonical replacement | Support window | Runtime behavior | Notes |
+| --- | --- | --- | --- | --- |
+| `metadata.ratingIcon` | `metadata.prefixIcon` | not-yet-defined | accepted for backward compatibility | Alias inferido da evidencia preservada; validar em runtime. |
+| `metadata.ratingMin` | `metadata.min` | not-yet-defined | accepted for backward compatibility | Alias inferido da evidencia preservada; validar em runtime. |
+| `metadata.ratingMax` | `metadata.max` | not-yet-defined | accepted for backward compatibility | Alias inferido da evidencia preservada; validar em runtime. |
+| `metadata.itemsCount` | `metadata.max` | not-yet-defined | accepted for backward compatibility | Alias inferido da evidencia preservada; validar em runtime. |
+| `metadata.ratingStep` | `metadata.step` | not-yet-defined | accepted for backward compatibility | Alias inferido da evidencia preservada; validar em runtime. |
+| `metadata.icon` | `metadata.prefixIcon` | not-yet-defined | accepted for backward compatibility | Alias inferido da evidencia preservada; validar em runtime. |
+| `metadata.prefixIcon` | `metadata.ratingIcon` | not-yet-defined | accepted for backward compatibility | Alias inferido da evidencia preservada; validar em runtime. |
+| `metadata.ratingColors` | `metadata.ratingToneColors` | not-yet-defined | accepted for backward compatibility | Alias inferido da evidencia preservada; validar em runtime. |
+
+### Internal-only paths
+
+Nao ha paths internal-only confirmados no contrato publico desta revisao.
+
+### Experimental paths
+
+Nao ha paths experimentais confirmados no contrato publico desta revisao.
+
+## Public contract surface (obrigatorio)
+
+### Top-level configuration blocks
+
+| Block | Purpose | Required | Merge strategy | Notes |
+| --- | --- | --- | --- | --- |
+| `metadata` | Payload declarativo principal do componente | true | deep-merge | runtime linkage verified for core flows (component specs, 2026-03-06). |
+| `0` | Configuracao especifica de runtime | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
+| `readonlyMode` | Override de readonly no host/runtime | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
+| `disabledMode` | Override de disabled no host/runtime | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
+| `visible` | Override de visibilidade no host/runtime | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
+| `presentationMode` | Renderizacao de apresentacao sem interacao | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
+
+### Nested configuration blocks
+
+| Path | Type | Required | Default | Constraints | Notes |
+| --- | --- | --- | --- | --- | --- |
+| `0.5` | unknown | false | n/a | component-defined | Partial; verify per source_of_truth. |
+| `metadata.ratingIcon` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
+| `metadata.prefixIcon` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
+| `metadata.inlineAutoSize.*` | object | false | n/a | component-defined | Partial; verify per source_of_truth. |
+| `metadata.quickPresets` | array | false | n/a | component-defined | Partial; verify per source_of_truth. |
+
+### Input bindings (inbound data)
+
+| Binding/Path | Type | Required | Source | Runtime normalization | Notes |
+| --- | --- | --- | --- | --- | --- |
+| `metadata` | object | true | host-json | component-defined | Primary inbound contract payload. |
+| `readonlyMode` | boolean | false | host-runtime | not-yet-verified | Host-level behavioral override. |
+| `disabledMode` | boolean | false | host-runtime | not-yet-verified | Host-level behavioral override. |
+| `visible` | boolean | false | host-runtime | not-yet-verified | Host-level behavioral override. |
+| `presentationMode` | boolean | false | host-runtime | not-yet-verified | Host-level behavioral override. |
+
+### Output events
+
+| Event | Payload | Trigger | Stability | Notes |
+| --- | --- | --- | --- | --- |
+| `valueChange` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
+| `focusChange` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
+| `nativeBlur` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
+| `nativeChange` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
+
+### External side channels
+
+| Channel | Direction | Contract | Failure mode | Notes |
+| --- | --- | --- | --- | --- |
+| `host/services/storage` | bidirectional | component-defined | component-defined | Side channels variam por componente e host; verificar em source_of_truth. |
+
+### Host/runtime dependencies
+
+| Dependency | Required | Environment | Purpose | Notes |
+| --- | --- | --- | --- | --- |
+| `inline-rating.component.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/components/inline-rating/inline-rating.component.ts`. |
+| `inline-range-slider.component.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/components/inline-range-slider/inline-range-slider.component.ts`. |
+| `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`. |
+
+## Coverage by surface (obrigatorio)
+
+### Coverage matrix (runtime, schema/type, editor/tooling)
+
+| Surface | Verified | Coverage status | Evidence | Notes |
+| --- | --- | --- | --- | --- |
+| Runtime | `true` | Active | `projects/praxis-dynamic-fields/src/lib/components/inline-rating/inline-rating.component.ts`, `projects/praxis-dynamic-fields/src/lib/components/inline-range-slider/inline-range-slider.component.ts` | Core runtime flows verified via focused component specs on 2026-03-06; editor/tooling coverage remains independent. |
+| Schema/Types | `true` | Active | source_of_truth + Detailed API reference | Reconcile schema/types with canonical paths during follow-up when needed. |
+| 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. |
+
+### Runtime coverage boundaries
+
+- Ambientes suportados: browser/dev/prod; SSR/hydration appears to be component-dependent unless explicitly verified.
+- Pre-condicoes: payload JSON valido, bindings de host consistentes e dependencias descritas no source_of_truth.
+- Fora de cobertura confirmada: caminhos internos, experimentais ou aliases nao enumerados formalmente.
+
+### Editor and tooling notes
+
+- Evidencia de tooling: aliases `pdx-inline-*` resolvidos por `inline-filter-controls.util.ts` e consumidos no `ComponentRegistryService`; editor visual E2E permanece not-yet-verified.
+- O que esta exposto no editor visual depende da cobertura real do workspace e nao deve ser inferido como suporte runtime total.
+- Campos disponiveis apenas via JSON/manual devem continuar no contrato, com rotulo explicito de cobertura parcial.
+- Quando houver divergencia entre editor e runtime, manter mismatch rastreavel em secao dedicada.
+
+## Resolution and precedence model (obrigatorio)
+
+### Merge order
+
+1. defaults do componente
+2. contrato JSON recebido
+3. overrides de host/runtime
+4. normalizacoes internas
+
+### Fallback order
+
+contrato explicito -> aliases historicos (quando suportados) -> defaults internos -> comportamento seguro
+
+### Override points
+
+- inputs publicos do componente
+- configuracao JSON de runtime
+- integracoes de host (servicos/tokens/adapters)
+
+### Runtime normalization
+
+Alias e defaults devem convergir para paths canonicos; onde nao houver evidencia, manter not-yet-verified de forma explicita.
+
+### Precedence rules
+
+Em conflito entre caminho historico e path canonico, priorizar path canonico e registrar janela de migracao do historico.
+
+## Validation and error semantics (obrigatorio)
+
+### Validation model
+
+| Path/Rule | Validation phase | Behavior on fail | Error code / warning | Notes |
+| --- | --- | --- | --- | --- |
+| canonical-paths | parse/runtime | component-defined (warn/reject/default) | not-yet-standardized | Semantica detalhada preservada na referencia tecnica por componente. |
+
+### Invalid and unknown field handling
+
+- Campos desconhecidos: comportamento component-defined (ignore, warn ou reject).
+- Tipos invalidos: pode haver fallback, warning ou falha, conforme runtime especifico.
+- Valores fora de dominio: registrar observed vs desired em Known limitations and mismatches.
+
+### Fail-open / fail-closed behavior
+
+| Condition | Mode | Runtime behavior | Consumer impact |
+| --- | --- | --- | --- |
+| invalid-or-unknown-field | component-defined | not-yet-verified | Pode gerar warning, fallback silencioso ou rejeicao; validar por componente. |
+
+### Runtime warnings vs hard failures
+
+| Condition | Severity | Observability | Consumer action |
+| --- | --- | --- | --- |
+| partial-or-declared-only-coverage | warning | logs/eventos do componente | Confirmar ligacao runtime antes de uso critico. |
+| mismatch-confirmed | error-or-warning | componente/host observability | Planejar migracao e corrigir contrato/runtime. |
+
+## Detailed API reference
+### Preserved technical reference (normalized from previous revision)
+
+### 1. Visao Geral e Quando Usar
+`pdx-inline-rating` e o filtro de rating inline com estrelas, slider de faixa e tema de tons (low/mid/high).
+
+Use quando precisar:
+- filtrar notas em escala (ex.: satisfacao, qualidade, risco);
+- operar em modo range com destaque visual por estrelas;
+- aplicar meia estrela e cores corporativas configuraveis.
+
+### 2. API do Componente (Inputs/Outputs)
+| Propriedade | Tipo | Padrao | Obrigatorio | Comportamento |
+| --- | --- | --- | --- | --- |
+| `metadata` | `MaterialRangeSliderMetadata` | - | Sim | Contrato principal do rating inline. |
+| `readonlyMode/disabledMode/visible/presentationMode` | `boolean` | `false/false/true/false` | Nao | Estados de host do campo inline. |
+| `valueChange` | `{start:number,end:number}` | - | Output herdado | Intervalo de rating selecionado. |
+
+### 3. Matriz de Cobertura JSON (Completa)
+#### 3.1 Campos especificos do componente
+| Caminho JSON | Tipo | Status | Comportamento em runtime |
+| --- | --- | --- | --- |
+| `metadata.min/max` e aliases `ratingMin/ratingMax/itemsCount` | `number` | Ativo | Limites da escala de rating. |
+| `metadata.step/ratingStep` | `number` | Ativo | Passo da escala. |
+| `metadata.allowHalf/ratingAllowHalf` | `boolean` | Ativo | Forca passo de meia estrela quando `true`. |
+| `metadata.ratingPrecision/precision` | `number\|string` | Ativo | Ajuste adicional de precisao (`0.5`/`half`). |
+| `metadata.ratingIcon` / `metadata.prefixIcon` | `string` | Ativo | Icone do trigger/cabecalho. |
+| `metadata.ratingToneColors/ratingColors/starColors` | `object\|array` | Ativo | Paleta para tons low/mid/high das estrelas. |
+| `metadata.ratingToneLowColor/mid/highColor` | `string` | Ativo | Override direto de cor por tom. |
+| `metadata.ratingGradientLowColor/midColor/highColor` | `string` | Ativo | Gradiente semantico aplicado na escala visual das estrelas. |
+| `metadata.ratingBadgeColor/ratingIndicatorColor` | `string` | Ativo | Cor de badges e indicador de escala. |
+| `metadata.inlineAutoSize.*` | `object` | Ativo | Largura do trigger e painel de rating. |
+| `metadata.quickPresets` | `array` | Ativo | Presets herdados do range inline para faixa de rating. |
+
+#### 3.2 Campos herdados compartilhados (exaustivo)
+- `projects/praxis-dynamic-fields/src/lib/components/inlineRange/pdx-inline-range-slider.json-api.md`
+- `projects/praxis-dynamic-fields/src/lib/components/material-range-slider/pdx-material-range-slider.json-api.md`
+
+Resumo de composicao deste componente:
+- `Ativo`: escala de estrelas com range e tema por tons.
+- `Extensao de runtime`: aliases `rating*` para semantica de dominio.
+
+### 4. Mapeamento de Comportamento
+- Sempre trabalha sobre valor de faixa (`start/end`) para representacao visual.
+- Estrelas mudam tom conforme banda (`low/mid/high`) e selecao atual.
+- Resolucao de passo prioriza `allowHalf`/`ratingAllowHalf`.
+- Presets e slider usam clamp por `min/max` com snap por `step`.
+
+### 5. Exemplo Minimo (JSON + Uso)
+```json
+{
+  "componentId": "pdx-inline-rating",
+  "metadata": {
+    "name": "rating",
+    "label": "Rating",
+    "controlType": "rangeSlider",
+    "ratingMin": 1,
+    "ratingMax": 5,
+    "ratingStep": 1
+  }
+}
+```
+Uso: filtro de rating inteiro (1 a 5).
+
+### 6. Exemplo Corporativo (JSON + Uso)
+```json
+{
+  "componentId": "pdx-inline-rating",
+  "metadata": {
+    "name": "npsBand",
+    "label": "NPS",
+    "controlType": "rangeSlider",
+    "mode": "range",
+    "ratingMin": 0,
+    "ratingMax": 10,
+    "ratingAllowHalf": true,
+    "ratingToneLowColor": "#dc2626",
+    "ratingToneMidColor": "#f59e0b",
+    "ratingToneHighColor": "#16a34a",
+    "ratingBadgeColor": "#f59e0b",
+    "inlineAutoSize": { "minWidth": 176, "maxWidth": 320, "panelMinWidth": 280, "panelMaxWidth": 400 },
+    "quickPresets": [
+      { "id": "detractors", "label": "Detratores", "start": 0, "end": 6 },
+      { "id": "promoters", "label": "Promotores", "start": 9, "end": 10 }
+    ]
+  }
+}
+```
+Uso: filtro corporativo de percepcao com bandas de NPS.
+
+### 7. Troubleshooting e Armadilhas Comuns
+1. Nao aplica meia estrela.
+Correcao: habilitar `allowHalf`/`ratingAllowHalf` ou `ratingPrecision=0.5`.
+
+2. Escala fora do esperado.
+Correcao: revisar `ratingMin/ratingMax` (ou `min/max`).
+
+3. Cores de tom nao mudam.
+Correcao: validar `ratingTone*` e fallback de paleta.
+
+4. Presets nao refletem no slider.
+Correcao: conferir intervalos de preset dentro de `min/max`.
+
+5. Trigger sem icone custom.
+Correcao: preencher `ratingIcon` ou `prefixIcon`.
+
+### 8. Cross-links
+- `projects/praxis-dynamic-fields/src/lib/components/inlineRange/pdx-inline-range-slider.json-api.md`
+- `projects/praxis-dynamic-fields/src/lib/components/material-range-slider/pdx-material-range-slider.json-api.md`
+
+### 9. Relatorio de Validacao Estrutural
+- Visao geral: PASS
+- API (inputs/outputs): PASS
+- Cobertura JSON completa (especifico + herdado): PASS
+- Mapeamento de comportamento: PASS
+- Exemplo minimo: PASS
+- Exemplo corporativo: PASS
+- Troubleshooting: PASS
+
+## JSON path index (obrigatorio)
+
+| Path | Type | Required | Default | Status | Notes |
+| --- | --- | --- | --- | --- | --- |
+| `metadata` | object | true | n/a | Partial | See Detailed API reference. |
+| `0.5` | unknown | false | n/a | Partial | See Detailed API reference. |
+| `metadata.ratingIcon` | string | false | n/a | Partial | See Detailed API reference. |
+| `metadata.prefixIcon` | string | false | n/a | Partial | See Detailed API reference. |
+| `metadata.inlineAutoSize.*` | object | false | n/a | Partial | See Detailed API reference. |
+| `metadata.quickPresets` | array | false | n/a | Partial | See Detailed API reference. |
+| `readonlyMode` | boolean | false | n/a | Partial | See Detailed API reference. |
+| `disabledMode` | boolean | false | n/a | Partial | See Detailed API reference. |
+| `visible` | boolean | false | n/a | Partial | See Detailed API reference. |
+| `presentationMode` | boolean | false | n/a | Partial | See Detailed API reference. |
+
+## Events reference (obrigatorio)
+
+| Event | Payload | Trigger | Stability | Notes |
+| --- | --- | --- | --- | --- |
+| `valueChange` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
+| `focusChange` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
+| `nativeBlur` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
+| `nativeChange` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
+
+## Styling API (obrigatorio quando aplicavel)
+
+| Token/Class | Scope | Purpose | Notes |
+| --- | --- | --- | --- |
+| `metadata.ratingIcon` | component | Styling-related JSON path | Validate against runtime implementation. |
+| `metadata.prefixIcon` | component | Styling-related JSON path | Validate against runtime implementation. |
+
+## Examples (obrigatorio)
+
+| Example | Scenario | Validates | Notes |
+| --- | --- | --- | --- |
+| `Minimal valid` | baseline payload | required contract blocks | Extracted from preserved technical reference when available. |
+| `Common setup` | common component usage | standard runtime behavior | Validate against host integration path. |
+| `Advanced setup` | richer config with overrides | precedence and normalization | Requires runtime confirmation for edge cases. |
+| `Enterprise scenario` | governance/legacy/migration context | auditability and compatibility boundaries | Include tenant-specific constraints when applicable. |
+
+### Minimal valid
+
+```json
+{
+  "componentId": "pdx-inline-rating",
+  "metadata": {
+    "name": "rating",
+    "label": "Rating",
+    "controlType": "rangeSlider",
+    "ratingMin": 1,
+    "ratingMax": 5,
+    "ratingStep": 1
+  },
+  "readonlyMode": false
+}
+```
+
+### Common setup
+
+```json
+{
+  "componentId": "pdx-inline-rating",
+  "metadata": {
+    "name": "npsBand",
+    "label": "NPS",
+    "controlType": "rangeSlider",
+    "mode": "range",
+    "ratingMin": 0,
+    "ratingMax": 10,
+    "ratingAllowHalf": true,
+    "ratingToneLowColor": "#dc2626",
+    "ratingToneMidColor": "#f59e0b",
+    "ratingToneHighColor": "#16a34a",
+    "ratingBadgeColor": "#f59e0b",
+    "inlineAutoSize": {
+      "minWidth": 176,
+      "maxWidth": 320,
+      "panelMinWidth": 280,
+      "panelMaxWidth": 400
+    },
+    "quickPresets": [
+      {
+        "id": "detractors",
+        "label": "Detratores",
+        "start": 0,
+        "end": 6
+      },
+      {
+        "id": "promoters",
+        "label": "Promotores",
+        "start": 9,
+        "end": 10
+      }
+    ],
+    "ratingIcon": "pdx-inline-rating-common"
+  }
+}
+```
+
+### Advanced setup
+
+```json
+{
+  "componentId": "pdx-inline-rating",
+  "metadata": {
+    "name": "npsBand",
+    "label": "NPS",
+    "controlType": "rangeSlider",
+    "mode": "range",
+    "ratingMin": 0,
+    "ratingMax": 10,
+    "ratingAllowHalf": true,
+    "ratingToneLowColor": "#dc2626",
+    "ratingToneMidColor": "#f59e0b",
+    "ratingToneHighColor": "#16a34a",
+    "ratingBadgeColor": "#f59e0b",
+    "inlineAutoSize": {
+      "minWidth": 176,
+      "maxWidth": 320,
+      "panelMinWidth": 280,
+      "panelMaxWidth": 400
+    },
+    "quickPresets": [
+      {
+        "id": "detractors",
+        "label": "Detratores",
+        "start": 0,
+        "end": 6
+      },
+      {
+        "id": "promoters",
+        "label": "Promotores",
+        "start": 9,
+        "end": 10
+      }
+    ]
+  },
+  "readonlyMode": false,
+  "disabledMode": false
+}
+```
+
+### Enterprise scenario
+
+```json
+{
+  "componentId": "pdx-inline-rating",
+  "metadata": {
+    "name": "npsBand",
+    "label": "NPS",
+    "controlType": "rangeSlider",
+    "mode": "range",
+    "ratingMin": 0,
+    "ratingMax": 10,
+    "ratingAllowHalf": true,
+    "ratingToneLowColor": "#dc2626",
+    "ratingToneMidColor": "#f59e0b",
+    "ratingToneHighColor": "#16a34a",
+    "ratingBadgeColor": "#f59e0b",
+    "inlineAutoSize": {
+      "minWidth": 176,
+      "maxWidth": 320,
+      "panelMinWidth": 280,
+      "panelMaxWidth": 400
+    },
+    "quickPresets": [
+      {
+        "id": "detractors",
+        "label": "Detratores",
+        "start": 0,
+        "end": 6
+      },
+      {
+        "id": "promoters",
+        "label": "Promotores",
+        "start": 9,
+        "end": 10
+      }
+    ]
+  },
+  "presentationMode": true,
+  "visible": true
+}
+```
+
+## Compatibility and migration notes (recomendado)
+
+| Concern | Affected versions | Migration action | Deadline | Notes |
+| --- | --- | --- | --- | --- |
+| Historical aliases coexist with canonical paths | Active consumers using legacy JSON keys | Keep canonical paths for new usage and map aliases in migration backlog | not-yet-defined | Track via component-level migration issue |
+
+## Known limitations and mismatches (recomendado)
+
+| Path/Behavior | Observed behavior (runtime) | Desired behavior | Impact | Tracking issue | Target fix |
+| --- | --- | --- | --- | --- | --- |
+| 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 |
+
+## Source references (obrigatorio)
+
+| Source type | Path/URL | Why it is source of truth | Last verified (YYYY-MM-DD) | Notes |
+| --- | --- | --- | --- | --- |
+| runtime-code | projects/praxis-dynamic-fields/src/lib/components/inline-rating/inline-rating.component.ts | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |
+| runtime-code | projects/praxis-dynamic-fields/src/lib/components/inline-range-slider/inline-range-slider.component.ts | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |
+| 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 |