net.wireservice.defs

wireservice.net

Documentation

aspectRatio object

Aspect ratio as a pair of integers, avoiding floating-point values.

Properties

height integer Required

No description available.

minimum: 1
width integer Required

No description available.

minimum: 1
View raw schema
{
  "description": "Aspect ratio as a pair of integers, avoiding floating-point values.",
  "properties": {
    "height": {
      "minimum": 1,
      "type": "integer"
    },
    "width": {
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "width",
    "height"
  ],
  "type": "object"
}
condition object

A condition for conditional design. Retained conditions are viewport dimensions, color scheme, and column count. Apple-specific conditions (app, platform, territory, subscriptionStatus) are intentionally omitted.

Properties

maxColumns integer Optional

Maximum number of layout columns.

minimum: 1
maxViewportAspectRatio integer Optional

Maximum viewport aspect ratio, expressed as width-over-height times 100 (e.g., 178 for 16:9).

minimum: 0
maxViewportWidth integer Optional

Maximum viewport width in points.

minimum: 0
minColumns integer Optional

Minimum number of layout columns.

minimum: 1
minViewportAspectRatio integer Optional

Minimum viewport aspect ratio, expressed as width-over-height times 100.

minimum: 0
minViewportWidth integer Optional

Minimum viewport width in points.

minimum: 0
preferredColorScheme string Optional

Color scheme condition for light/dark mode.

maxLength: 64 bytes
Known values: any, light, dark
View raw schema
{
  "description": "A condition for conditional design. Retained conditions are viewport dimensions, color scheme, and column count. Apple-specific conditions (app, platform, territory, subscriptionStatus) are intentionally omitted.",
  "properties": {
    "maxColumns": {
      "description": "Maximum number of layout columns.",
      "minimum": 1,
      "type": "integer"
    },
    "maxViewportAspectRatio": {
      "description": "Maximum viewport aspect ratio, expressed as width-over-height times 100 (e.g., 178 for 16:9).",
      "minimum": 0,
      "type": "integer"
    },
    "maxViewportWidth": {
      "description": "Maximum viewport width in points.",
      "minimum": 0,
      "type": "integer"
    },
    "minColumns": {
      "description": "Minimum number of layout columns.",
      "minimum": 1,
      "type": "integer"
    },
    "minViewportAspectRatio": {
      "description": "Minimum viewport aspect ratio, expressed as width-over-height times 100.",
      "minimum": 0,
      "type": "integer"
    },
    "minViewportWidth": {
      "description": "Minimum viewport width in points.",
      "minimum": 0,
      "type": "integer"
    },
    "preferredColorScheme": {
      "description": "Color scheme condition for light/dark mode.",
      "knownValues": [
        "any",
        "light",
        "dark"
      ],
      "maxLength": 64,
      "type": "string"
    }
  },
  "type": "object"
}
margin object

Margin with top and bottom values.

Properties

bottom ref #measurement Optional

No description available.

View raw schema
{
  "description": "Margin with top and bottom values.",
  "properties": {
    "bottom": {
      "ref": "#measurement",
      "type": "ref"
    },
    "top": {
      "ref": "#measurement",
      "type": "ref"
    }
  },
  "type": "object"
}
measurement object

A numeric value with a unit, replacing ANF's SupportedUnits string format (e.g., '10vw').

Properties

unit string Required

No description available.

maxLength: 64 bytes
Known values: pt, vw, vh, vmin, vmax, dg, dm, cw, gut
value integer Required

No description available.

View raw schema
{
  "description": "A numeric value with a unit, replacing ANF's SupportedUnits string format (e.g., '10vw').",
  "properties": {
    "unit": {
      "knownValues": [
        "pt",
        "vw",
        "vh",
        "vmin",
        "vmax",
        "dg",
        "dm",
        "cw",
        "gut"
      ],
      "maxLength": 64,
      "type": "string"
    },
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value",
    "unit"
  ],
  "type": "object"
}
padding object

Padding with top, bottom, left, and right values.

Properties

bottom ref #measurement Optional

No description available.

View raw schema
{
  "description": "Padding with top, bottom, left, and right values.",
  "properties": {
    "bottom": {
      "ref": "#measurement",
      "type": "ref"
    },
    "left": {
      "ref": "#measurement",
      "type": "ref"
    },
    "right": {
      "ref": "#measurement",
      "type": "ref"
    },
    "top": {
      "ref": "#measurement",
      "type": "ref"
    }
  },
  "type": "object"
}
strokeStyle object

Stroke style for borders and dividers.

Properties

color string Optional

Hex color string (e.g., '#FF0000').

maxLength: 64 bytes
lineStyle string Optional

No description available.

maxLength: 64 bytes
Known values: solid, dashed, dotted
width integer Optional

No description available.

minimum: 1
View raw schema
{
  "description": "Stroke style for borders and dividers.",
  "properties": {
    "color": {
      "description": "Hex color string (e.g., '#FF0000').",
      "maxLength": 64,
      "type": "string"
    },
    "lineStyle": {
      "knownValues": [
        "solid",
        "dashed",
        "dotted"
      ],
      "maxLength": 64,
      "type": "string"
    },
    "width": {
      "minimum": 1,
      "type": "integer"
    }
  },
  "type": "object"
}
textRun object

A run of text with optional formatting marks.

Properties

View raw schema
{
  "description": "A run of text with optional formatting marks.",
  "properties": {
    "marks": {
      "items": {
        "closed": false,
        "refs": [
          "net.wireservice.richtext.bold",
          "net.wireservice.richtext.code",
          "net.wireservice.richtext.italic",
          "net.wireservice.richtext.link",
          "net.wireservice.richtext.strikethrough",
          "net.wireservice.richtext.subscript",
          "net.wireservice.richtext.superscript",
          "net.wireservice.richtext.underline"
        ],
        "type": "union"
      },
      "type": "array"
    },
    "text": {
      "maxGraphemes": 10000,
      "maxLength": 100000,
      "type": "string"
    }
  },
  "required": [
    "text"
  ],
  "type": "object"
}

Lexicon Garden

@