Switch

Overview

API Reference: UI.Switch

Switch is a two-state toggle button. Switch allows the user to select between two options. (e.g. on/off)

note

The components in the example are added from the code for better showcase purposes. To learn more about the subject you can refer to:

Adding Component From Code

As a best practice, Smartface recommends using the WYSIWYG editor in order to add components and styles to your page or library. To learn how to use UI Editor better, please refer to this documentation

UI Editor Basics

scripts/pages/pageSample.ts

import PageSampleDesign from "generated/pages/pageSample";
import { Route, Router } from "@smartface/router";
import { styleableComponentMixin } from "@smartface/styling-context";
import Application from "@smartface/native/application";
import Switch from "@smartface/native/ui/switch";
import System from "@smartface/native/device/system";

class StyleableSwitch extends styleableComponentMixin(Switch) {}

//You should create new Page from UI-Editor and extend with it.
export default class Sample extends PageSampleDesign {
  mySwitch: StyleableSwitch;
  constructor(private router?: Router, private route?: Route) {
    super({});
  }

  // The page design has been made from the code for better
  // showcase purposes. As a best practice, remove this and
  // use WYSIWYG editor to style your pages.
  centerizeTheChildrenLayout() {
    this.style.apply({
      flexProps: {
        flexDirection: "ROW",
        justifyContent: "CENTER",
        alignItems: "CENTER",
      },
    });
  }

  onShow() {
    super.onShow();
    const { headerBar } =
      System.OS === System.OSType.ANDROID ? this : this.parentController;
    Application.statusBar.visible = false;
    headerBar.visible = false;
  }

  onLoad() {
    super.onLoad();

    this.centerizeTheChildrenLayout();

    this.mySwitch = new StyleableSwitch({});
    this.addChild(this.mySwitch, "mySwitch", ".switch", {
      toggleOnColor: "rgba( 65, 117, 5, 1 )",
      thumbOnColor: "rgba( 126, 211, 33, 1 )",
      thumbOffColor: "rgba( 208, 2, 27, 1 )",
      toggleOffColor: "rgba( 0, 0, 0, 1 )",
    });
  }
}