Stepper Svelte Component

Stepper Svelte component represents Stepper component.

Stepper Components

There are following components included:

  • Stepper

Stepper Properties

PropTypeDefaultDescription
<Stepper> properties
initbooleantrueInitializes Stepper
valuenumber0Stepper value
minnumber0Minimum value
maxnumber100Maximum value
stepnumber1Maximum value
wrapsbooleanfalseWhen enabled, incrementing beyond maximum value sets value to minimum value; likewise, decrementing below minimum value sets value to maximum value
autorepeatbooleanfalseWhen enabled it will repeatedly increase/decrease values while you tap and hold plus/minus buttons
autorepeatDynamicbooleanfalseWhen enabled it will increase autorepeat ratio based on how long you hold the button
inputbooleantrueDefines should it render <input> element or not
inputReadonlybooleanfalseMakes inner input element readonly
namestringInput element "name" attribute
buttonsOnlybooleanfalseDisables inner value container between stepper buttons
formatValuefunction(value)Custom function to format value for value element between buttons. It must return new formatted value
manualInputModebooleanfalseEnables manual input mode. This mode allows to type value from keyboar and check fractional part with defined accurancy. Also, step parameter is ignored when typing in this mode.
decimalPointnumber4Number of digits after dot, when in manual input mode.
buttonsEndInputModebooleantrueDisables manual input mode on Stepper's minus or plus button click.
disabledbooleanfalseDefines whether the stepper is disabled or not
roundbooleanfalseMakes stepper round
roundIosbooleanfalseMakes stepper round for iOS theme only
roundMdbooleanfalseMakes stepper round for MD theme only
roundAurorabooleanfalseMakes stepper round for Aurora theme only
largebooleanfalseMakes large stepper
largeIosbooleanfalseMakes large stepper for iOS theme only
largeMdbooleanfalseMakes large stepper for MD theme only
largeAurorabooleanfalseMakes large stepper for Aurora theme only
smallbooleanfalseMakes small stepper
smallIosbooleanfalseMakes small stepper for iOS theme only
smallMdbooleanfalseMakes small stepper for MD theme only
smallAurorabooleanfalseMakes small stepper for Aurora theme only
fillbooleanfalseMakes stepper filled color
fillIosbooleanfalseMakes stepper filled color for iOS theme only
fillMdbooleanfalseMakes stepper filled color for MD theme only
fillAurorabooleanfalseMakes stepper filled color for Aurora theme only
raisedbooleanfalseMakes stepper raised.
raisedIosbooleanfalseMakes stepper raised for iOS theme.
raisedMdbooleanfalseMakes stepper raised for MD theme.
raisedAurorabooleanfalseMakes stepper raised for Aurora theme.

Stepper Events

EventDescription
<Stepper> events
stepperChangeEvent will be triggered when Stepper value has been changed
stepperMinusClickEvent will be triggered on "minus" button click
stepperPlusClickEvent will be triggered on "plus" button click
inputEvent will be triggered on input's input event

Stepper Methods

EventDescription
<Stepper> methods
.increment()Increment stepper value, similar to clicking on its "plus" button
.decremenet()Decrement stepper value, similar to clicking on its "minus" button
.setValue(newValue)Set new stepper value
.getValue()Returns stepper value

Examples

<Page>
  <Navbar title="Stepper"></Navbar>
  <BlockTitle>Shape and size</BlockTitle>
  <Block strong class="text-align-center">
    <Row>
      <Col>
        <small class="display-block">Default</small>
        <Stepper></Stepper>
      </Col>
      <Col>
        <small class="display-block">Round</small>
        <Stepper round></Stepper>
      </Col>
    </Row>

    <Row class="margin-top">
      <Col>
        <small class="display-block">Fill</small>
        <Stepper fill></Stepper>
      </Col>
      <Col>
        <small class="display-block">Round Fill</small>
        <Stepper fill round></Stepper>
      </Col>
    </Row>

    <Row class="margin-top">
      <Col>
        <small class="display-block">Small</small>
        <Stepper small></Stepper>
      </Col>
      <Col>
        <small class="display-block">Small Round</small>
        <Stepper small round></Stepper>
      </Col>
    </Row>

    <Row class="margin-top">
      <Col>
        <small class="display-block">Small Fill</small>
        <Stepper small fill></Stepper>
      </Col>
      <Col>
        <small class="display-block">Small Round Fill</small>
        <Stepper small round fill></Stepper>
      </Col>
    </Row>

    <Row class="margin-top">
      <Col>
        <small class="display-block">Large</small>
        <Stepper large></Stepper>
      </Col>
      <Col>
        <small class="display-block">Large Round</small>
        <Stepper large round></Stepper>
      </Col>
    </Row>

    <Row class="margin-top">
      <Col>
        <small class="display-block">Large Fill</small>
        <Stepper large fill></Stepper>
      </Col>
      <Col>
        <small class="display-block">Large Round Fill</small>
        <Stepper large round fill></Stepper>
      </Col>
    </Row>
  </Block>

  <BlockTitle>Raised</BlockTitle>
  <Block strong class="text-align-center">
    <Row>
      <Col>
        <small class="display-block">Default</small>
        <Stepper raised></Stepper>
      </Col>
      <Col>
        <small class="display-block">Round</small>
        <Stepper raised round></Stepper>
      </Col>
    </Row>

    <Row class="margin-top">
      <Col>
        <small class="display-block">Fill</small>
        <Stepper raised fill></Stepper>
      </Col>
      <Col>
        <small class="display-block">Round Fill</small>
        <Stepper raised fill round></Stepper>
      </Col>
    </Row>

    <Row class="margin-top">
      <Col>
        <small class="display-block">Small</small>
        <Stepper raised small></Stepper>
      </Col>
      <Col>
        <small class="display-block">Small Round</small>
        <Stepper raised small round></Stepper>
      </Col>
    </Row>

    <Row class="margin-top">
      <Col>
        <small class="display-block">Small Fill</small>
        <Stepper raised small fill></Stepper>
      </Col>
      <Col>
        <small class="display-block">Small Round Fill</small>
        <Stepper raised small round fill></Stepper>
      </Col>
    </Row>

    <Row class="margin-top">
      <Col>
        <small class="display-block">Large</small>
        <Stepper raised large></Stepper>
      </Col>
      <Col>
        <small class="display-block">Large Round</small>
        <Stepper raised large round></Stepper>
      </Col>
    </Row>

    <Row class="margin-top">
      <Col>
        <small class="display-block">Large Fill</small>
        <Stepper raised large fill></Stepper>
      </Col>
      <Col>
        <small class="display-block">Large Round Fill</small>
        <Stepper raised large round fill></Stepper>
      </Col>
    </Row>
  </Block>
  <BlockTitle>Colors</BlockTitle>
  <Block strong class="text-align-center">
    <Row>
      <Col>
        <Stepper fill color="red"></Stepper>
      </Col>
      <Col>
        <Stepper fill round color="green"></Stepper>
      </Col>
    </Row>

    <Row class="margin-top">
      <Col>
        <Stepper fill color="blue"></Stepper>
      </Col>
      <Col>
        <Stepper fill round color="pink"></Stepper>
      </Col>
    </Row>

    <Row class="margin-top">
      <Col>
        <Stepper fill small color="yellow"></Stepper>
      </Col>
      <Col>
        <Stepper fill small round color="orange"></Stepper>
      </Col>
    </Row>

    <Row class="margin-top">
      <Col>
        <Stepper fill small color="gray"></Stepper>
      </Col>
      <Col>
        <Stepper fill small round color="black"></Stepper>
      </Col>
    </Row>
  </Block>
  <BlockTitle>Without input element</BlockTitle>
  <Block strong class="text-align-center">
    <Row>
      <Col>
        <Stepper input={false}></Stepper>
      </Col>
      <Col>
        <Stepper input={false} round></Stepper>
      </Col>
    </Row>
  </Block>
  <BlockTitle>Min, max, step</BlockTitle>
  <Block strong class="text-align-center">
    <Row>
      <Col>
        <Stepper fill value={100} min={0} max={1000} step={100}></Stepper>
      </Col>
      <Col>
        <Stepper fill input={false} value={5} min={0} max={10} step={0.5}></Stepper>
      </Col>
    </Row>
  </Block>

  <BlockTitle>Autorepeat (Tap & hold)</BlockTitle>
  <BlockHeader>Pressing and holding one of its buttons increments or decrements the stepper’s value repeatedly. With dynamic autorepeat, the rate of change depends on how long the user continues pressing the control.</BlockHeader>
  <Block strong class="text-align-center">
    <Row>
      <Col>
        <small class="display-block">Default</small>
        <Stepper fill value={0} min={0} max={100} step={1} autorepeat={true}></Stepper>
      </Col>
      <Col>
        <small class="display-block">Dynamic</small>
        <Stepper fill value={0} min={0} max={100} step={1} autorepeat={true} autorepeatDynamic={true}></Stepper>
      </Col>
    </Row>
  </Block>

  <BlockTitle>Wraps</BlockTitle>
  <BlockHeader>In wraps mode incrementing beyond maximum value sets value to minimum value, likewise, decrementing below minimum value sets value to maximum value</BlockHeader>
  <Block strong class="text-align-center">
    <Row>
      <Col>
        <Stepper fill value={0} min={0} max={10} step={1} autorepeat={true} wraps={true}></Stepper>
      </Col>
    </Row>
  </Block>

  <BlockTitle>Custom value element</BlockTitle>
  <List>
    <ListItem title={`Apples ${applesCount}`}>
      <span slot="after">
        <Stepper buttonsOnly={true} small raised onStepperChange={setApples}></Stepper>
      </span>
    </ListItem>
    <ListItem title={`Oranges ${orangesCount}`}>
      <span slot="after">
        <Stepper buttonsOnly={true} small raised onStepperChange={setOranges}></Stepper>
      </span>
    </ListItem>
  </List>

  <BlockTitle>Custom value format</BlockTitle>
  <List>
    <ListItem header="Meeting starts in" title={meetingTimeComputed}>
      <span slot="after">
        <Stepper
          min={15}
          max={240}
          step={15}
          value={meetingTime}
          buttonsOnly={true}
          small
          fill
          raised
          onStepperChange={setMeetingTime}
        ></Stepper>
      </span>
    </ListItem>
  </List>

  <BlockTitle>Manual input</BlockTitle>
  <BlockHeader>It is possible to enter value manually from keyboard or mobile keypad. When click on input field, stepper enter into manual input mode, which allow type value from keyboar and check fractional part with defined accurancy. Click outside or enter Return key, ending manual mode.</BlockHeader>
  <Block strong class="text-align-center">
    <Row>
      <Col>
        <Stepper fill value={0} min={0} max={1000} step={1} autorepeat={true} wraps={true} manualInputMode={true} decimalPoint={2}></Stepper>
      </Col>
    </Row>
  </Block>
</Page>
  


<script>
  import { Page, Navbar, BlockTitle, Block, BlockHeader, Row, Col, List, ListItem, Stepper } from 'framework7-svelte';

  let applesCount = 0;
  let orangesCount = 0;
  let meetingTime = 15;

  $: meetingTimeComputed = (() => {
    const value = meetingTime;

    const hours = Math.floor(value / 60);
    const minutes = value - (hours * 60);
    const formatted = [];
    if (hours > 0) {
      formatted.push(hours + ' ' + (hours > 1 ? 'hours' : 'hour'));
    }
    if (minutes > 0) {
      formatted.push(minutes + ' minutes');
    }
    return formatted.join(' ');
  })();

  function setApples(value) {
    applesCount = value;
  }
  function setOranges(value) {
    orangesCount = value;
  }
  function setMeetingTime(value) {
    meetingTime = value;
  }
</script>