m3e/pan_gesture

PanGesture is a non-visual element used to detect a pan gesture for an associated element.

This file was generated by m3e/generator

     DO NOT EDIT

Types

Config

</>

Config is a public record for configuring this component.

pub type Config {
  Config(
    allowed_buttons: gesture_input_button.GestureInputButton,
    disabled: Disabled,
    priority: Float,
    min_displacement: Float,
    min_duration: String,
    lock_axis: pan_gesture_lock_axis.PanGestureLockAxis,
    axis_threshold: Float,
    delta_threshold: Float,
    for: option.Option(String),
  )
}

Constructors

Config(
  allowed_buttons: gesture_input_button.GestureInputButton,
  disabled: Disabled,
  priority: Float,
  min_displacement: Float,
  min_duration: String,
  lock_axis: pan_gesture_lock_axis.PanGestureLockAxis,
  axis_threshold: Float,
  delta_threshold: Float,
  for: option.Option(String),
)

Disabled

</>

Disabled is whether gesture recognition is disabled.

pub type Disabled {
  IsDisabled
  IsNotDisabled
}

Constructors

```
IsDisabled
```
```
IsNotDisabled
```

PanGesture

opaque </>

PanGesture is a View Model for this component

Fields:

allowed_buttons: Which buttons can be pressed.
disabled: Whether gesture recognition is disabled.
priority: The priority in which to recognize gestures.
min_displacement: Minimum distance (px) a pointer can move before the gesture starts.
min_duration: Minimum time (ms) a pointer must remain pressed.
lock_axis: Locks movement to an axis.
axis_threshold: Minimum total displacement (px) required before axis locking resolves orientation.
delta_threshold: Minimum incremental movement (px) on the secondary axis required before emitting move updates.
for: The identifier of the interactive control to which this element is attached.

pub opaque type PanGesture

Values

allowed_buttons

</>

pub fn allowed_buttons(
  record: PanGesture,
  allowed_buttons: gesture_input_button.GestureInputButton,
) -> PanGesture

allowed_buttons sets the value of allowed_buttons for this PanGesture.

axis_threshold

</>

pub fn axis_threshold(
  record: PanGesture,
  axis_threshold: Float,
) -> PanGesture

axis_threshold sets the value of axis_threshold for this PanGesture.

default_allowed_buttons

</>

pub const default_allowed_buttons: gesture_input_button.GestureInputButton

default_axis_threshold

</>

pub const default_axis_threshold: Float

default_config

</>

pub fn default_config() -> Config

default_config is the default configuration for this component.

default_delta_threshold

</>

pub const default_delta_threshold: Float

default_disabled

</>

pub const default_disabled: Disabled

default_for

</>

pub const default_for: option.Option(String)

default_lock_axis

</>

pub const default_lock_axis: pan_gesture_lock_axis.PanGestureLockAxis

default_min_displacement

</>

pub const default_min_displacement: Float

default_min_duration

</>

pub const default_min_duration: String

default_priority

</>

pub const default_priority: Float

delta_threshold

</>

pub fn delta_threshold(
  record: PanGesture,
  delta_threshold: Float,
) -> PanGesture

delta_threshold sets the value of delta_threshold for this PanGesture.

disabled

</>

pub fn disabled(
  record: PanGesture,
  disabled: Disabled,
) -> PanGesture

disabled sets the value of disabled for this PanGesture.

for

</>

pub fn for(
  record: PanGesture,
  for: option.Option(String),
) -> PanGesture

for sets the value of for for this PanGesture.

from_config

</>

pub fn from_config(config: Config) -> PanGesture

from_config creates a new PanGesture from the given configuration.

lock_axis

</>

pub fn lock_axis(
  record: PanGesture,
  lock_axis: pan_gesture_lock_axis.PanGestureLockAxis,
) -> PanGesture

lock_axis sets the value of lock_axis for this PanGesture.

min_displacement

</>

pub fn min_displacement(
  record: PanGesture,
  min_displacement: Float,
) -> PanGesture

min_displacement sets the value of min_displacement for this PanGesture.

min_duration

</>

pub fn min_duration(
  record: PanGesture,
  min_duration: String,
) -> PanGesture

min_duration sets the value of min_duration for this PanGesture.

new

</>

pub fn new() -> PanGesture

new creates a new PanGesture with the default configuration.

priority

</>

pub fn priority(
  record: PanGesture,
  priority: Float,
) -> PanGesture

priority sets the value of priority for this PanGesture.

render

</>

pub fn render(
  model: PanGesture,
  attributes: List(attribute.Attribute(msg)),
) -> element.Element(msg)

render creates a Lustre Element for a PanGesture

render_config

</>

pub fn render_config(
  c: Config,
  attributes: List(attribute.Attribute(msg)),
) -> element.Element(msg)

render_config creates a Lustre Element from a PanGesture Config