UIButton v1alpha1

apiVersion: tilt.dev/v1alpha1

import "github.com/tilt-dev/tilt/pkg/apis/core/v1alpha1"

UIButton

UIButton


UIButtonSpec

UIButtonSpec defines the desired state of UIButton


  • location (UIComponentLocation), required

    Location associates the button with another component for layout.

    UIComponentLocation specifies where to put a UI component.

    • location.componentID (string), required

      ComponentID is the identifier of the parent component to associate this component with.

      For example, this is a resource name if the ComponentType is Resource.

    • location.componentType (string), required

      ComponentType is the type of the parent component.

  • text (string), required

    Text to appear on the button itself or as hover text (depending on button location).

  • disabled (boolean)

    If true, the button will be rendered, but with an effect indicating it’s disabled. It will also be unclickable.

  • iconName (string)

    IconName is a Material Icon to appear next to button text or on the button itself (depending on button location).

    Valid values are icon font ligature names from the Material Icons set. See https://fonts.google.com/icons for the full list of available icons.

    If both IconSVG and IconName are specified, IconSVG will take precedence.

  • iconSVG (string)

    IconSVG is an SVG to use as the icon to appear next to button text or on the button itself (depending on button location).

    This should be an <svg> element scaled for a 24x24 viewport.

    If both IconSVG and IconName are specified, IconSVG will take precedence.

  • inputs ([]UIInputSpec)

    Any inputs for this button.

    Defines an Input to render in the UI. If UIButton is analogous to an HTML <form>, UIInput is analogous to an HTML .

    • inputs.name (string), required

      Name of this input. Must be unique within the UIButton.

    • inputs.label (string)

      A label to display next to this input in the UI.

    • inputs.text (UITextInputSpec)

      A Text input that takes a string.

      **

    • inputs.text.defaultValue (string)

      Initial value for this field.

    • inputs.text.placeholder (string)

      A short hint that describes the expected input of this field.

UIButtonStatus

UIButtonStatus defines the observed state of UIButton


  • inputs ([]UIInputStatus)

    Status of any inputs on this button.

    The status corresponding to a UIInputSpec

    • inputs.name (string), required

      Name of the input whose status this is. Must match the Name of a corresponding UIInputSpec.

    • inputs.text (UITextInputStatus)

      The status of a text input

      **

    • inputs.text.value (string), required

      The content of the text input.

  • lastClickedAt (MicroTime)

    LastClickedAt is the timestamp of the last time the button was clicked.

    If the button has never clicked before, this will be the zero-value/null.

    MicroTime is version of Time with microsecond level precision.

UIButtonList

UIButtonList


  • apiVersion: tilt.dev/v1alpha1

  • kind: UIButtonList

  • metadata (ListMeta)

  • items ([]UIButton), required

Operations


get read the specified UIButton

HTTP Request

GET /apis/tilt.dev/v1alpha1/uibuttons/{name}

Parameters

  • name (in path): string, required

    name of the UIButton

  • pretty (in query): string

    pretty

Response

200 (UIButton): OK

get read status of the specified UIButton

HTTP Request

GET /apis/tilt.dev/v1alpha1/uibuttons/{name}/status

Parameters

  • name (in path): string, required

    name of the UIButton

  • pretty (in query): string

    pretty

Response

200 (UIButton): OK

list list or watch objects of kind UIButton

HTTP Request

GET /apis/tilt.dev/v1alpha1/uibuttons

Parameters

Response

200 (UIButtonList): OK

create create an UIButton

HTTP Request

POST /apis/tilt.dev/v1alpha1/uibuttons

Parameters

Response

200 (UIButton): OK

201 (UIButton): Created

202 (UIButton): Accepted

update replace the specified UIButton

HTTP Request

PUT /apis/tilt.dev/v1alpha1/uibuttons/{name}

Parameters

  • name (in path): string, required

    name of the UIButton

  • body: UIButton, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • pretty (in query): string

    pretty

Response

200 (UIButton): OK

201 (UIButton): Created

update replace status of the specified UIButton

HTTP Request

PUT /apis/tilt.dev/v1alpha1/uibuttons/{name}/status

Parameters

  • name (in path): string, required

    name of the UIButton

  • body: UIButton, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • pretty (in query): string

    pretty

Response

200 (UIButton): OK

201 (UIButton): Created

patch partially update the specified UIButton

HTTP Request

PATCH /apis/tilt.dev/v1alpha1/uibuttons/{name}

Parameters

  • name (in path): string, required

    name of the UIButton

  • body: Patch, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • force (in query): boolean

    force

  • pretty (in query): string

    pretty

Response

200 (UIButton): OK

patch partially update status of the specified UIButton

HTTP Request

PATCH /apis/tilt.dev/v1alpha1/uibuttons/{name}/status

Parameters

  • name (in path): string, required

    name of the UIButton

  • body: Patch, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • force (in query): boolean

    force

  • pretty (in query): string

    pretty

Response

200 (UIButton): OK

delete delete an UIButton

HTTP Request

DELETE /apis/tilt.dev/v1alpha1/uibuttons/{name}

Parameters

Response

200 (Status): OK

202 (Status): Accepted

deletecollection delete collection of UIButton

HTTP Request

DELETE /apis/tilt.dev/v1alpha1/uibuttons

Parameters

Response

200 (Status): OK