[Components](https://oods-foundry.com/components) / viz.encoding

# VizAxisControls

Edits axis labels, visibility and formatting.

Generated from @oods/foundry 0.10.1

- Categories

  viz.encoding

- Contexts

  form

- Readiness

  `react-and-vue`

## Playground

This component's contract doesn't list typed props, so the playground shows its documented example.

Documented example `VizAxisControls` : append x to the first field, {"encodings":{"x":{"field":"periodx","title":"Period","sort":"ascending"}}}.

The render follows the page's theme switch: light, dark or high contrast. Both frameworks render the same example.

The real VizAxisControls, live

React

Axis

Axis field

Axis title

Sort

Vue

Axis

Axis field

Axis title

Sort

Events it emits: change. Use either render above, and each event shows here with the framework that sent it.



## Code

The documented example. HTML is the markup the React component renders for it, which @oods/component-styles styles.

**React**

```
import { VizAxisControls } from '@oods/components-react';
import '@oods/component-styles/css';

const value = {
  "encodings": {
    "x": {
      "field": "period",
      "title": "Period",
      "sort": "ascending"
    }
  }
};

export function Example() {
  return (
    <VizAxisControls
      value={value}
    />
  );
}
```

## Props, slots and events

Contract version 1.1.0. Types are from the React declarations in @oods/components-react.

Props

| Prop | Type | Required | Documented example |
| - | - | - | - |
| `title` | `string \| undefined` | no | |
| `value` | `VizIntentFragment \| undefined` | no | `{"encodings":{"x":{"field":"period","title":"Period","sort":"ascending"}}}` |
| `channel` | `"x" \| "y" \| undefined` | no | |
| `disabled` | `boolean \| undefined` | no | |

### Slots

none

### Events

change

## States

bound, editing, invalid, disabled

## Accessibility

- Role

  `textbox`

- How it gets its name

  `label` on `input[name="x.field"]`

### Keyboard

Keyboard

| Key | What it does |
| - | - |
| `Tab` | Focus the labelled chart input |
| `x` | Edit the declared field name |

### Obligations in the contract

- Native labelled controls expose focus and invalid-edit feedback; successful edits emit a typed viz.render input fragment.

Axis: controls the public Cartesian viz.render fragment, not the legacy HTML placeholder's unimplemented styling fields. The consumer supplies rows and calls the renderer. Opacity uses six bounded presets; fields/colors/scale/chart type preserve sibling input bindings. No consumer action is executed by this component.

## Tokens

The token roles this component reads.

- `input.background`
- `input.border`
- `input.text`
- `input.focus`
- `field.message`

## Readiness

The evidence recorded for this component, with its label.

`react-and-vue`: catalog_list gives this label when the React and Vue components have complete readiness evidence, but the sweep's generated apps don't use the component in both.

Readiness evidence

| Evidence | React | Vue |
| - | - | - |
| state | implemented-evidence-complete | implemented-evidence-complete |
| versioned contract | passed | passed |
| target implementation | passed | passed |
| package export | passed | passed |
| public declaration | passed | passed |
| dependency closure | passed | passed |
| framework scenario | passed | passed |
| accessibility | verified | verified |
| interaction | verified | verified |
| visual themes | verified | verified |

## Use your own

You can replace this component with your own React or Vue component. Map it, and generated code imports yours at the exact version you name. A contract report, run in a real browser, lists what your component met, what it didn't, and what wasn't checked.

The `component_map` call, with the parts in angle brackets yours to fill:

```
{
  "action": "create",
  "apply": true,
  "externalSystem": "<your design system>",
  "externalComponent": "<YourVizAxisControls>",
  "oodsTraits": [
    "EncodingPositionX",
    "EncodingPositionY"
  ],
  "substitution": {
    "component": "VizAxisControls",
    "react": {
      "package": "<your-package>/react",
      "version": "<exact version>",
      "export": "<YourVizAxisControls>"
    },
    "vue": {
      "package": "<your-package>/vue",
      "version": "<exact version>",
      "export": "<YourVizAxisControls>"
    }
  }
}
```

## How this page was made

Generated at build from the published data, each source with the hash of what was read. [The page's manifest](https://oods-foundry.com/components/viz-axis-controls/manifest.json).

- **Contract**: `@oods/component-contracts@0.10.1 componentContracts.VizAxisControls` `sha256:35ea5833de86…`
- **Documented example**: `@oods/component-contracts@0.10.1 sharedScenarios VizAxisControls` `sha256:efd919797dcd…`
- **Catalog entry (catalog_list)**: `generated/0.10.1/system/catalog.json VizAxisControls` `sha256:71739299e1ba…`
- **React readiness**: `@oods/components-react@0.10.1 readiness VizAxisControls` `sha256:bd37fcfaf6fa…`
- **Vue readiness**: `@oods/components-vue@0.10.1 readiness VizAxisControls` `sha256:706fb4a42061…`
- **Prop types**: `generated/0.10.1/components/prop-types.json VizAxisControls` `sha256:3200947d11d0…`