Back

addSwitch

JS Py
Hello World
Content:
- Examples
- Properties
- Methods

A Switch in mobile UI design is a toggle control that allows users to turn a setting on or off.

swt = ui.addSwitch( parent, text, options?, width?, height? ) → ui object: Switch

Here are the available methods of the Switch Component.

Examples

Example - Basic

class Main extends App
{
    onStart()
    {
        // Creates a layout with objects verticaly centered
        this.main = ui.addLayout("main", "Linear", "VCenter,FillXY")

        // Adds a switch to the main layout
        this.swt = ui.addSwitch(this.main, "Check me", "Secondary", 0.5)

        // Add a callback handler when the switch control is touch
        this.swt.setOnTouch( this.onTouch )
    }

    onTouch( value )
    {
        ui.showPopup("Value is : " + value)

        // Setting the switch label text
        this.swt.text = `Check me (Value is ${value})`
    }
}
from hybrid import ui

def OnStart():
    global swt
    # Creates a layout with objects verticaly centered
    main = ui.addLayout("main", "Linear", "VCenter,FillXY")

    # Adds a switch to the main layout
    swt = ui.addSwitch(main, "Check me", "Secondary", 0.5)

    # Add a callback handler when the switch control is touch
    swt.setOnTouch(onTouch)

def onTouch(value):
    ui.showPopup("Value is : " + value)

    # Setting the switch label text
    swt.text = f"Check me (Value is {value})"
Copy All       Run      

Example - Right switch with custom styles

class Main extends App
{
    onStart()
    {
        // Creates a layout with objects verticaly centered
        this.main = ui.addLayout("main", "Linear", "VCenter,FillXY")

        // Adds a switch control to the main layout
        // `Right` option will display the switch on the right
        this.swt = ui.addSwitch(this.main, "Check me", "Right,Secondary", 0.5)

        // Add some custom styling to thw switch control
        this.swt.border = 1
        this.swt.padding = ["1.2rem"]
        this.swt.cornerRadius = 4
        this.swt.backColor = "yellow"

        // Add a callback handler when the switch control is touch
        this.swt.setOnTouch( this.onTouch )
    }

    onTouch( value )
    {
        ui.showPopup("Value is : " + value)
    }
}
from hybrid import ui

def OnStart():
    # Creates a layout with objects verticaly centered
    main = ui.addLayout("main", "Linear", "VCenter,FillXY")

    # Adds a switch control to the main layout
    # `Right` option will display the switch on the right
    swt = ui.addSwitch(main, "Check me", "Right,Secondary", 0.5)

    # Add some custom styling to thw switch control
    swt.border = 1
    swt.padding = ["1.2rem"]
    swt.cornerRadius = 4
    swt.backColor = "yellow"

    # Add a callback handler when the switch control is touch
    swt.setOnTouch(onTouch)

def onTouch(value):
    ui.showPopup("Value is : " + value)
Copy All       Run      

Properties

The following properties are available on the Switch object:

absHeight → Number
absLeft → Number
absTop → Number
absWidth → Number
backColor → String
backImage → String
border → Number
borderColor → String
borderStyle → String
color → String
cornerRadius → Number
disabled → Boolean
disableRipple → Boolean
edge → String
el → Object
elStyle → String
enable → Boolean
fontFile → String
height → Number
iconPosition → String
isVisible → Boolean
left → Number
margins → List
opacity → Number
options → String
padding → List
parent → Object
position → Object
required → Boolean
rotation → Number
sizeVariant → String
spaceBetween → Number
text → String
textColor → String
textSize → Number
top → Number
type → String
value → Boolean
visibility → String
width → Number

Methods

The following methods are available on the Switch object:

animate( anim, duration )
bringForward( zIndex )
destroy()
getPosition( options ) → Object
gone()
hide()
sendBackward( zIndex )
setBorder( left?, top?, right?, bottom?, clr?, style? )
setCornerRadius( tl?, tr?, br?, bl?, mode? )
setMargins( left?, top?, right?, bottom?, mode? )
setOnContextMenu( callback )
setOnTouch( callback )
setPadding( left?, top?, right?, bottom?, mode? )
setPosition( left, top, mode )
setScale( x, y )
setSize( width, height, mode )
show()
Number: Fraction of the parent width `[0-1]`.
Number: Fraction of the parent height `[0-1]`.
Number: The time in milliseconds.
Number: The z-index. A negative value behaves like `sendBackward` method.
Number: The z-index. A positve value behaves like `bringForward` method.
Number: Border-left thickness in pixels.
Number: Border-top thickness in pixels.
Number: Border-right thickness in pixels.
Number: Border-bottom thickness in pixels.
Number: Top-Left border radius.
Number: Top-Right border radius.
Number: Bottom-Right border radius.
Number: Bottom-Left border radius.
Number: Left margin. You can also pass string e.g. `12rem`
Number: Top margin. You can also pass string e.g. `12rem`
Number: Right margin. You can also pass string e.g. `12rem`
Number: Bottom margin. You can also pass string e.g. `12rem`
Number: Fraction of the component width.
Number: Fraction of the component height. [0-1]
Number: Fraction of the component width. [0-1]
Number: Fraction of the parent width. [0-1]
Number: Fraction of the parent height. [0-1]
Number: The x-scale of the component.Values less than `0` is smaller than the normal. While values greater than `1` is greater than the normal.
Number: The y-scale of the component. Values less than `1` is smaller than the normal. While vaues greater than `1` is greater than the normal.
String: “The label text.”
String: “A comma separated options.
Theme Color: `Primary`”, “ `Secondary`”, “ `Default`
Icon Position: `Left`”, “ `Top`”, “ `Right`”, “ `Bottom`
Sizes: `Small`”, “ `Medium`”
String: “The type of animation. Here are the available values
`bounce`”, “ `flash`”, “ `pulse`”, “ `rubberBand`”, “ `shakeX`”, “ `shakeY`”, “ `headShake`”, “ `swing`”, “ `tada`”, “ `wobble`”, “ `jello`”, “ `heartBeat`”, “
Back Entrances: `backInDown`”, “ `backInLeft`”, “ `backInRight`”, “ `backInUp`
Back Exits: `backOutDown`”, “ `backOutLeft`”, “ `backOutRight`”, “ `backOutUp`
Bouncing Entrances: `bounceIn`”, “ `bounceInDown`”, “ `bounceInLeft`”, “ `bounceInRight`”, “ `bounceInUp`
Bouncing exits: `bounceOut`”, “ `bounceOutDown`”, “ `bounceOutLeft`”, “ `bounceOutRight`”, “ `bounceOutUp`
Fading entrances: `fadeIn`”, “ `fadeInDown`”, “ `fadeInDownBig`”, “ `fadeInLeft`”, “ `fadeInLeftBig`”, “ `fadeInRight`”, “ `fadeInRightBig`”, “ `fadeInUp`”, “ `fadeInUpBig`”, “ `fadeInTopLeft`”, “ `fadeInTopRight`”, “ `fadeInBottomLeft`”, “ `fadeInBottomRight`
Fading exits: `fadeOut`”, “ `fadeOutDown`”, “ `fadeOutDownBig`”, “ `fadeOutLeft`”, “ `fadeOutLeftBig`”, “ `fadeOutRight`”, “ `fadeOutRightBig`”, “ `fadeOutUp`”, “ `fadeOutUpBig`”, “ `fadeOutTopLeft`”, “ `fadeOutTopRight`”, “ `fadeOutBottomRight`”, “ `fadeOutBottomLeft`
Flippers: `flip`”, “ `flipInX`”, “ `flipInY`”, “ `flipOutX`”, “ `flipOutY`
Lightspeed: `lightSpeedInRight`”, “ `lightSpeedInLeft`”, “ `lightSpeedOutRight`”, “ `lightSpeedOutLeft`
Rotating Entrances: `rotateIn`”, “ `rotateInDownLeft`”, “ `rotateInDownRight`”, “ `rotateInUpLeft`”, “ `rotateInUpRight`
Rotating Exits: `rotateOut`”, “ `rotateOutDownLeft`”, “ `rotateOutDownRight`”, “ `rotateOutUpLeft`”, “ `rotateOutUpRight`
Specials: `hinge`”, “ `jackInTheBox`”, “ `rollIn`”, “ `rollOut`
Zooming Entrances: `zoomIn`”, “ `zoomInDown`”, “ `zoomInLeft`”, “ `zoomInRight`”, “ `zoomInUp`
Zooming Exits: `zoomOut`”, “ `zoomOutDown`”, “ `zoomOutLeft`”, “ `zoomOutRight`”, “ `zoomOutUp`
Sliding Entrances: `slideInDown`”, “ `slideInLeft`”, “ `slideInRight`”, “ `slideInUp`
Sliding Exits: `slideOutDown`”, “ `slideOutLeft`”, “ `slideOutRight`”, “ `slideOutUp`”
String: “The mode of the measurements. Values can be `px` or `%`”
String: “Border color in hexadecimal format `#rrggbb`.”
String: “Border-styles. Values can be `dotted`”, “ `dashed`”, “ `solid`”, “ `double`”, “ `groove`”, “ `ridge`”, “ `inset` and `outset`. Default is `solid`”
String: “Unit of measurement. Values are `px` `rem` or `%`.”
String: “Unit of measurement.
`rem` for root em.
`px` for pixels
`%` relative to its parent dimension.
`v` relative to viewport dimension.”
String: “Unit of measurement.
`rem` for root em.
`px` for pixels
`%` relative to its parent dimensions
`v` relative to viewport dimensions.”
String: “Unit of measurment. Can be "px"”, “ "rem"”, “ "%"”, “ "v" for viewport width/height or any css supported unit.”
Object: The parent layout where to add the Switch Component.
Object: The pointer event object.
Object: The position of the event.
function( event )
function( check , pos )
swt.absHeight
Returns the absolute height of the control in pixels.
swt.absLeft
Returns the absolute distance of the control from the left in pixels.
swt.absTop
Returns the absolute distance of the control from the top in pixels.
swt.absWidth
Returns the absolute width of the control in pixels.
swt.animate
Animate the component.
swt.backColor
A hexadecimal color of the form #rrggbb
swt.backImage
The path to your image file.
swt.border
Sets or returns the border thickness in pixels.
swt.borderColor
Sets or returns the border color. Color is in hexadecimal form #rrggbb
swt.borderStyle
Sets or returns the border style. Values can be dotted, dashed, solid, double, groove, ridge, inset and outset. Default is solid.
swt.bringForward
Bring this component forward by a given z-index.
swt.color
Sets or returns the theme color. Values can be Default Primary or Secondary
swt.cornerRadius
Sets or returns the corner radius in pixels.
swt.destroy
Destroy the component.
swt.disabled
Sets or returns the disabled state of the control.
swt.disableRipple
Sets or returns the disabled state of the ripple effect.
swt.edge
Sets or returns the edge position of the toggle. Values can be Start End or False
swt.el
Returns the html container element for the control.
swt.elStyle
Sets the style of the html container element.
swt.enable
Sets or returns a Boolean whether the component is enabled or disabled.
swt.fontFile
Sets or returns the relative path to the font-family use.
swt.getPosition
Returns the position of the component. The return object is of the form {left, top, right, bottom}
swt.gone
Destroy the component.
swt.height
Sets or returns the height of the control as a fraction of the parent control.
swt.hide
Hide the component.
swt.iconPosition
Sets or returns the icon position. Values can be left top right or bottom
swt.isVisible
Returns whether the control is visible or not.
swt.left
Returns the distance of the control from the left.
swt.margins
Sets or returns the margin of the control. Works on controls with Linear parent only. You can also pass a number to set equal margins for all sides.
swt.opacity
Sets or returns the opacity of the control.
swt.options
Sets or returns the options of the control.
swt.padding
Sets or returns the padding of the control. You can also pass a number to set equal padding for all sides.
swt.parent
Returns the parent layout control.
swt.position
Returns the position of the control. The returned object has left top right and bottom props.
swt.required
Sets or returns a boolean value whether this component is required or not.
swt.rotation
Sets or returns the angle of rotation in degrees.
swt.sendBackward
Bring this component backward by a given z-index.
swt.setBorder
Sets the border line for the component container.
swt.setCornerRadius
Sets the corner radius of the component.
swt.setMargins
Sets the margin of the component.
swt.setOnContextMenu
Adds a callback function on right click.
swt.setOnTouch
Adds an event handler when the switch is touch.
swt.setPadding
Sets the padding of the component's container.
swt.setPosition
Sets the position of the component relative to its parent dimensions.
swt.setScale
Sets the x and y scaling of the component. This will ignore the positioning and flow of controls in the layout.
swt.setSize
Sets the size of the component.
swt.show
Show the component.
swt.sizeVariant
Sets or returns the size variant of the toggle switch. Values can be Small or Medium
swt.spaceBetween
Sets or returns the space between the switch icon and the label text.
swt.text
Sets or returns the label text.
swt.textColor
Sets or returns the color of the text.
swt.textSize
Sets or returns the size of the text within the control.
swt.top
Returns the distance of the control from the top.
swt.type
Returns the type of the control.
swt.value
Sets or returns the value of the switch toggle.
swt.visibility
Sets or returns the visibility of the control.
swt.width
Sets or returns the width of the control as a fraction of the parent control.