scu-input

released in beta

component

parameters

states

scu-input

<scu-input></scu-input>

scu-input

Properties

Property	Attribute	Type	Default
`autocapitalize`	`autocapitalize`	`string`	`undefined`
`autocomplete`	`autocomplete`	`string`	`undefined`
`autocorrect`	`autocorrect`	`string`	`undefined`
`autofocus`	`autofocus`	`boolean`	`undefined`
`disabled`	`disabled`	`boolean`	`false`
`focused`	`focused`	`boolean`	`false`
`isFormElement`	`is-form-element`	`boolean`	`true`
`max`	`max`	`number`	`undefined`
`maxlength`	`maxlength`	`number`	`undefined`
`min`	`min`	`number`	`undefined`
`minlength`	`minlength`	`number`	`undefined`
`name`	`name`	`string`	`undefined`
`pattern`	`pattern`	`string`	`undefined`
`required`	`required`	`boolean`	`undefined`
`step`	`step`	`string`	`undefined`
`touched`	`touched`	`boolean`	`false`
`type`	`type`	`InputTypes`	`InputTypes.text`
`valid`	`valid`	`boolean`	`true`
`validateOn`	`validate-on`	`InputValidateOn.blur \| InputValidateOn.focus \| InputValidateOn.input`	`InputValidateOn.blur`
`value`	`value`	`string`	`undefined`

Methods

`validate() => Promise<ValidityState>`

Returns

Type: Promise<ValidityState>

Built with StencilJS

no state examples

History

v0.0.9 - 2020/10/20
- Syncing versioning between scu-components-beta and Figma file SCU-DesignSystem.
- Reference portability. Can be viewed via unpkg.com (see reference)
- scu-stack - stubbed out. A simplier way to layout vertical stacks using padding and gaps based on spacing. scu-flex-v is mostly redundant to default behavior and can get in the way for simple stacks of content.
- scu-input-text (Figma) - stubbed out.
- scu-input-textarea (Figma) - stubbed out.
- scu-input-radio (Figma) - stubbed out.
- scu-input-checkbox (Figma) - stubbed out.
v0.0.8 - 2020/10/18
- scu-icon - created. Understands where the icons are and the available sizes. It can also color the icon anything from the available token colors.
- scu-text - created. Has all of the typography and color tokens integrated into API.
- scu-flex-h - created. Easy way to layout horizontal flexbox.
- scu-flex-v - created. Easy way to layout vertical flexbox.
- scu-flex-fill - created. Easy way to add a flexible element within scu-flex-h/v.
...v0.0.7 - 2020/10
- Setting up environment and integrating tokenization
- scu-button - created. Contains a number of variations including outline, icon, icon only.
- scu-member-profile - created
- scu-vertical-navigation-item - created

Summit Design System

The Summit Design System is our design process. It is composed of a shared design library for designers built in Figma, tokens driven from that Figma library, and a reusable JavaScript component library built with web components using StencilJS. This should work within any development framework (Vue, Angular, etc).

Implementation

HTML

To build a simple static HTML page, like a prototype, add these two lines to an HTML page running within a server (see "Server" if you don't have a server running locally)


    <script src="https://unpkg.com/scu-components-beta/dist/scu/scu.esm.js" type="module"></script>

    <link href="https://unpkg.com/scu-components-beta/dist/scu/scu.css" rel="stylesheet">

Within the HTML page you can just start dropping components:


    <scu-button label='Submit' outline></scu-button>

Server

Vue

Stencil Vue Documentation

With Vue you need to first add the SCU Design System to your project then add the custom element definitions and tell Vue to ignore all components with the "scu-" prefix. This is an example of the main.js file of a simple Vue app.


    npm install --save scu-components-beta


    import Vue from 'vue'
    import App from './App.vue'
    import { applyPolyfills, defineCustomElements } from 'scu-components-beta/loader';

    Vue.config.productionTip = false

    // Tell Vue to ignore all components prefixed 'scu-'
    Vue.config.ignoredElements = [/scu-\w*/];

    // Bind the custom elements to the window object
    applyPolyfills().then(() => {
      defineCustomElements();
    });

    new Vue({
      render: h => h(App),
    }).$mount('#app')

Angular

Stencil Angular Documentation

Other

Stencil Documentation