---
title: "pdx-inline-number JSON API (Canonical)"
slug: "pdx-inline-number-json-api"
doc_type: "api-reference"
component: "pdx-inline-number"
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-number."
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-number/inline-number.component.ts"
  - "projects/praxis-dynamic-fields/src/lib/base/simple-base-input.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-number"
api_stability: "canonical"
schema_verified: true
runtime_verified: true
editor_coverage_verified: false
runtime_scope: "public"
legacy_paths_present: false
has_known_mismatches: false
related_components:
  - "praxis-table"
  - "pdx-number-input"
  - "pdx-base-input-runtime-contract"
---

# pdx-inline-number

Este documento e a referencia canonica da API JSON de pdx-inline-number.

## 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-number` | 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-number/inline-number.component.ts`, `projects/praxis-dynamic-fields/src/lib/base/simple-base-input.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 | `false` | Manter consistencia entre contrato canonico e caminhos documentados | Active | 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-number/inline-number.component.ts | runtime-code | Arquivo presente no repositorio e usado como evidencia de contrato. |
| projects/praxis-dynamic-fields/src/lib/base/simple-base-input.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 | `false` | 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. |
| `metadata.min` | number | false | n/a | Partial | See Detailed API reference for runtime semantics. |
| `metadata.max` | number | false | n/a | Partial | See Detailed API reference for runtime semantics. |
| `metadata.step` | number | false | n/a | Partial | See Detailed API reference for runtime semantics. |
| `metadata.inputMode` | string | false | n/a | Partial | See Detailed API reference for runtime semantics. |
| `metadata.numberFormat.percentage` | unknown | false | n/a | Partial | See Detailed API reference for runtime semantics. |
| `metadata.clearButton` | object | 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. |

### Path audit

Nenhum desvio de caminho foi identificado nesta revisao.

### 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). |
| `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 |
| --- | --- | --- | --- | --- | --- |
| `metadata.min` | number | false | n/a | component-defined | Partial; verify per source_of_truth. |
| `metadata.max` | number | false | n/a | component-defined | Partial; verify per source_of_truth. |
| `metadata.step` | number | false | n/a | component-defined | Partial; verify per source_of_truth. |
| `metadata.inputMode` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
| `metadata.numberFormat.percentage` | unknown | false | n/a | component-defined | Partial; verify per source_of_truth. |
| `metadata.clearButton` | object | 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. |

### 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-number.component.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/components/inline-number/inline-number.component.ts`. |
| `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`. |
| `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-number/inline-number.component.ts`, `projects/praxis-dynamic-fields/src/lib/base/simple-base-input.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-number` e um campo numerico inline com suporte a modo percentual e limites efetivos.

Use quando precisar:
- filtro numerico compacto em toolbar;
- sufixo `%` quando formato percentual;
- controle fino de min/max/step no proprio campo.

### 2. API do Componente (Inputs/Outputs)
| Propriedade | Tipo | Padrao | Obrigatorio | Comportamento |
| --- | --- | --- | --- | --- |
| `metadata` | `MaterialNumericMetadata` | - | Sim | Contrato principal do number inline. |
| `readonlyMode/disabledMode/visible/presentationMode` | `boolean` | `false/false/true/false` | Nao | Estados de host. |
| `valueChange` | `number \| null` | - | Output base input | Mudanca do valor numerico. |

### 3. Matriz de Cobertura JSON (Completa)
#### 3.1 Campos especificos do componente
| Caminho JSON | Tipo | Status | Comportamento em runtime |
| --- | --- | --- | --- |
| `metadata.min` | `number` | Ativo | Limite minimo efetivo do campo. |
| `metadata.max` | `number` | Ativo | Limite maximo efetivo do campo. |
| `metadata.step` | `number` | Ativo | Incremento do input numerico. |
| `metadata.inputMode` | `string` | Ativo | Define `inputmode` (ex.: decimal/numeric). |
| `metadata.numberFormat.percentage` | `boolean` | Ativo | Ativa modo percentual com sufixo `%`. |
| `metadata.clearButton` | `boolean \| object` | Ativo | Quick-clear no sufixo. |
| `metadata.inlineAutoSize.*` | `object` | Ativo | Ajuste de largura minima/maxima por viewport. |

#### 3.2 Campos herdados compartilhados (exaustivo)
- [pdx-number-input.json-api.md](projects/praxis-dynamic-fields/src/lib/components/number-input/pdx-number-input.json-api.md)
- [pdx-base-input-runtime-contract.json-api.md](projects/praxis-dynamic-fields/src/lib/base/pdx-base-input-runtime-contract.json-api.md)

Resumo de composicao deste componente:
- `Ativo`: limites numericos, modo percentual, autosize e clear.
- `Extensao de runtime`: tuning inline de largura.

### 4. Mapeamento de Comportamento
- Modo percentual ajusta semantica visual e valores default de faixa/passo.
- `metadata.inlineVisualStyle = "graphic"` materializa leitura percentual enriquecida, mas o componente suprime gauge/rail decorativos quando esta dentro de `praxis-filter` compacto para manter a barra densa e escaneavel.
- Campo recalcula largura com base no conteudo/placeholder e limites configurados.
- Validadores `min/max` sao aplicados no control conforme metadata.

### 5. Exemplo Minimo (JSON + Uso)
```json
{
  "componentId": "pdx-inline-number",
  "metadata": {
    "name": "qty",
    "label": "Quantidade",
    "controlType": "number",
    "min": 0,
    "max": 999,
    "step": 1
  }
}
```
Uso: filtro numerico simples.

### 6. Exemplo Corporativo (JSON + Uso)
```json
{
  "componentId": "pdx-inline-number",
  "metadata": {
    "name": "discount",
    "label": "Desconto",
    "controlType": "number",
    "numberFormat": { "percentage": true },
    "min": 0,
    "max": 100,
    "step": 0.5,
    "inlineAutoSize": { "minWidth": 120, "maxWidth": 240 },
    "clearButton": { "enabled": true, "showOnlyWhenFilled": true }
  }
}
```
Uso: filtro percentual em pill para politica comercial.

### 7. Troubleshooting e Armadilhas Comuns
1. Sufixo `%` nao aparece.
Correcao: ativar `numberFormat.percentage=true`.

2. Valor fora da faixa aceita.
Correcao: conferir `min/max` e validacao backend correspondente.

3. Campo muito curto para leitura.
Correcao: ajustar limites de `inlineAutoSize`.

4. Step inesperado em percentual.
Correcao: definir `step` explicitamente.

5. Clear indisponivel.
Correcao: revisar `clearButton` e estados readonly/disabled.

### 8. Cross-links
- `projects/praxis-dynamic-fields/src/lib/components/number-input/pdx-number-input.json-api.md`
- `projects/praxis-dynamic-fields/src/lib/base/pdx-base-input-runtime-contract.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. |
| `metadata.min` | number | false | n/a | Partial | See Detailed API reference. |
| `metadata.max` | number | false | n/a | Partial | See Detailed API reference. |
| `metadata.step` | number | false | n/a | Partial | See Detailed API reference. |
| `metadata.inputMode` | string | false | n/a | Partial | See Detailed API reference. |
| `metadata.numberFormat.percentage` | unknown | false | n/a | Partial | See Detailed API reference. |
| `metadata.clearButton` | object | false | n/a | Partial | See Detailed API reference. |
| `metadata.inlineAutoSize.*` | object | 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 |
| --- | --- | --- | --- |
| `not-yet-verified` | component | Styling contract not yet verified | Use Detailed API reference for component-specific styling notes. |

## 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-number",
  "metadata": {
    "name": "qty",
    "label": "Quantidade",
    "controlType": "number",
    "min": 0,
    "max": 999,
    "step": 1
  },
  "readonlyMode": false
}
```

### Common setup

```json
{
  "componentId": "pdx-inline-number",
  "metadata": {
    "name": "discount",
    "label": "Desconto",
    "controlType": "number",
    "numberFormat": {
      "percentage": true
    },
    "min": 0,
    "max": 100,
    "step": 0.5,
    "inlineAutoSize": {
      "minWidth": 120,
      "maxWidth": 240
    },
    "clearButton": {
      "enabled": true,
      "showOnlyWhenFilled": true
    }
  },
  "readonlyMode": true
}
```

### Advanced setup

```json
{
  "componentId": "pdx-inline-number",
  "metadata": {
    "name": "discount",
    "label": "Desconto",
    "controlType": "number",
    "numberFormat": {
      "percentage": true
    },
    "min": 5,
    "max": 100,
    "step": 0.5,
    "inlineAutoSize": {
      "minWidth": 120,
      "maxWidth": 240
    },
    "clearButton": {
      "enabled": true,
      "showOnlyWhenFilled": true
    }
  },
  "readonlyMode": false,
  "disabledMode": false
}
```

### Enterprise scenario

```json
{
  "componentId": "pdx-inline-number",
  "metadata": {
    "name": "discount",
    "label": "Desconto",
    "controlType": "number",
    "numberFormat": {
      "percentage": true
    },
    "min": 0,
    "max": 100,
    "step": 0.5,
    "inlineAutoSize": {
      "minWidth": 120,
      "maxWidth": 240
    },
    "clearButton": {
      "enabled": true,
      "showOnlyWhenFilled": true
    }
  },
  "presentationMode": true,
  "visible": true
}
```

## Compatibility and migration notes (recomendado)

| Concern | Affected versions | Migration action | Deadline | Notes |
| --- | --- | --- | --- | --- |
| 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 |

## 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-number/inline-number.component.ts | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |
| runtime-code | projects/praxis-dynamic-fields/src/lib/base/simple-base-input.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 |