패키지, 저장소 및 앱 카테고리 검색

패키지 상세v0.2.1

input_sheet

광범위한 양식을 가진 앱을 도와주는 플러터 패키지로, 입력 항목을 BottomSheet로 구현하여 사용자 경험을 향상시킵니다.

30일 다운로드
45
좋아요
46
Pub 점수
40

패키지 설치

flutter pub add input_sheet

패키지 개요

공개 정보를 바탕으로 생성한 선택 가이드입니다.

InputSheet는 광범위한 양식을 포함하는 앱의 사용성을 향상시키기 위해 입력 항목을 BottomSheet에 표시하여 폼 입력 경험을 개선하도록 설계된 Flutter 패키지입니다. 다양한 입력 유형에 적응할 수 있는 깔끔하고 직관적인 인터페이스를 제공하여 모바일 기기에서 원활한 사용자 경험을 보장합니다. BottomSheet 접근 방식은 메인 화면을 혼잡하게 하지 않으면서도 폼에 쉽게 접근할 수 있도록 해주며, 데이터 중심 애플리케이션에 이상적입니다. 기존의 Flutter 프로젝트와 원활하게 통합되며 반응형 디자인 원칙을 지원합니다.

사용 사례

  • 긴 형식 데이터 입력
  • 모바일 우선 폼 인터페이스
  • 화면 혼잡도 줄이기
  • 입력 접근성 향상
  • 양식을 통한 사용자 참여도 향상

주요 기능

  • BottomSheet 기반 입력 레이아웃
  • 다양한 입력 유형 지원
  • Flutter 폼과의 간편한 통합
  • 반응형 및 적응형 디자인
  • 사용자 정의 가능한 외관 및 동작

적합한 대상

  • 모바일 앱 개발자
  • 폼 중심 애플리케이션
  • 사용자 경험 중심의 UI 디자인
  • 접근성에 대한 인식을 가진 개발
  • 간편한 입력 워크플로우가 필요한 앱

고려 사항

  • 모바일 플랫폼에 한정
  • 폼 상태를 수동으로 처리해야 합니다
  • 복잡한 레이아웃의 경우 추가 스타일링이 필요할 수 있습니다
  • Flutter의 BottomSheet 위젯에 의존합니다
  • 데스크톱 또는 웹 사용에 적합하지 않습니다

원본 README

연결된 소스 저장소의 README 원문 스냅샷입니다. 최신 내용은 저장소에서 확인하세요.

flutter-input-sheet

Pub License: MIT

A pack of input types implemented as a sheet! 🚀

Overview

flutter-input-sheet is a package that shows inputs on sheets.

It was created with the purpose of make simple and pleasant extensive forms. You can create custom components to present your data and edit them in sheets for each one.

It was developed by abstracting and implementing great packages in pub.dev to create a single and simple pack for forms.

Installation

add this line to pubspec.yaml

input_sheet: <latest_version>
Dependencies

Also, this package uses some other libraries that need to be imported in your project to work, this libraries is used in some input types that need constants informed at params.

camera: ^0.5.8+1
video_compress: ^2.0.0
flutter_cupertino_date_picker: ^1.0.12
IOS

You will need to add permissions in your Info.plist to use camera and microphone once the package has an input for photos and videos

<key>NSCameraUsageDescription</key>
<string>Can I use the camera please?</string>
<key>NSMicrophoneUsageDescription</key>
<string>Can I use the mic please?</string>
Android

You will need to add permissions in your AndroidManifest.xml to read and write external storage and manage the camera once the package has an input for photos and videos

<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="18" />

✨ Features

  • [x] Text
  • [x] Longtext
  • [x] Masked
  • [x] Number
  • [x] Date
  • [x] Time
  • [x] DateTime
  • [x] Photo
  • [x] Video
  • [x] MultiOption
  • [ ] Slider
  • [ ] Color
  • [ ] Qrcode
  • [ ] Map

⭐ Basic components

Was created some basic components to show data information on screen before open the input sheet.

  • IpsCard

  • IpsLabel

  • IpsError

  • IpsIcon

  • IpsValue

  • IpsPhoto

  • IpsVideo

Examples

Basic card component:

This library implements a basic and optional card component to simplify its forms when presenting data.

//Your component to show data
IpsCard(
    label: IpsLabel("Name"),
    value: IpsValue(_name ?? "Touch to edit..."),
    icon: IpsIcon(FeatherIcons.user),
    error: IpsError(_errors['name']),
    onClick: () {
        //Your sheet implementation
    },
);

Basic media component:

Also for media types, you may want to preview the media, so I created a simple component to show Photo and Video.

//Photo component preview file
IpsPhoto(
    file: _photo,
    onClick: (){
        //Your sheet implementation
    }
);

//Video component preview thumbnail
IpsVideo(
    thumbnail: _thumbnailVideo,
    onClick: (){
        //Your sheet implementation
    },
);

Opening a sheet:
InputSheet(
    //InputSheet implements the scope information of sheet
    context,
    label: "Name",
    cancelText: "Cancel",
    doneText: "Confirm",
).text(
    //.text or any other option available type implemets the input type
    placeholder: "Type here...",
    value: _name,
    onDone: (dynamic value) => setState(() {
        _name = value;
    }),
);

Complete simple example:
class _MyHomePageState extends State<MyHomePage> {
  String _name;
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: SingleChildScrollView(
        child: Padding(
          padding: EdgeInsets.all(25),
          child: IpsCard(
                label: IpsLabel("Name"),
                value: IpsValue(_name ?? "Touch to edit..."),
                icon: IpsIcon(FeatherIcons.user),
                error: IpsError(_errors['name']),
                onClick: () => InputSheet(
                  context,
                  label: "Name",
                  cancelText: "Cancel",
                  doneText: "Confirm",
                ).text(
                  placeholder: "Type here...",
                  value: _name,
                  onDone: (dynamic value) => setState(() {
                    _name = value;
                  }),
                ),
            ),
        ),
      ),
    );
  }
}


The InputSheet factory

It will be instanced for each input sheet type you want to invoke, on this Factory you can pass some scope parameters of your sheet.

InputSheet(context,
  label: "Your name",
  cancelText: "Cancel button",
  doneText: "Done button",
  keyboardAutofocus: true,
);
Parameters Type Description
label String The message showing above input
cancelText String The cancel button text
doneText String The confirmation button text
keyboardAutofocus bool Auto-focus editable inputs after open sheet

The input types

Text

This input implements a simple text input.

InputSheet(context).text(
    textInputType: TextInputType.text,
    placeholder: "Type here...",
    value: _value,
    onDone: (String value) => setState(() {
        _value = value;
    }),
);
Parameters Type Description
textInputType TextInputType The default keyboard input type
placeholder String Add a placeholder to input
value String Add a default value to input
onDone Function(String) Callback function called when done ediding input text

Longtext

This input implements a long text input that break lines and increase the sheet height according the value length.

InputSheet(context).longtext(
    placeholder: "Type here...",
    value: _value,
    onDone: (String value) => setState(() {
        _value = value;
    }),
);
Parameters Type Description
placeholder String Add a placeholder to input
value String Add a default value to input
onDone Function(String) Callback function called when done ediding input text

Mask

This input uses flutter_masked_text package to manage the mask patterns and switch from pattern to pattern according the value length, see the package to learn about this patterns.

InputSheet(context).mask(
    masks: ['(00) 0000-0000', '(00) 0 0000-0000'],
    textInputType: TextInputType.text,
    placeholder: "Type here...",
    value: _value,
    onDone: (String value) => setState(() {
        _value = value;
    }),
);
Parameters Type Description
masks List<\String> The mask pattern that the input will use according the number of characters value
textInputType TextInputType The default keyboard input type
placeholder String Add a placeholder to input
value String Add a default value to input
onDone Function(String) Callback function called when done ediding input text

Number

This input uses flutter_masked_text package to manage symbols and separators, then you can configure it to implement number or currency inputs.

InputSheet(context).number(
    leftSymbol: "to pay:",
    rightSymbol: "U\$",
    decimalSeparator: ".",
    thousandSeparator: ",",
    precision: 2,
    placeholder: "Type here...",
    value: _value,
    onDone: (double value) => setState(() {
        _value = value;
    }),
);
Parameters Type Description
leftSymbol String Blank default, is used only on input
rightSymbol String Blank default, is used only on input
decimalSeparator String Default " . " is used only on input
thousandSeparator String Default " , " is used only on input
precision int The number of decimal places
placeholder String Add a placeholder to input
value String Add a default value to input
onDone Function(String) Callback function called when done ediding input text

Date

This input uses flutter_cupertino_date_picker to manage state and formatters on Date picker.

InputSheet(context).date(
    minDateTime: DateTime.now().subtract(Duration(days: 365 * 100)),
    maxDateTime: DateTime.now(),
    locale: DateTimePickerLocale.en_us,
    format: "yyyy-MM-dd",
    pickerFormat: "yyyy|MMMM|dd",
    value: _value,
    onDone: (String value) => setState(() {
        _value = value;
    }),
);
Parameters Type Description
minDateTime DateTime Min date available to select
maxDateTime DateTime Max date abailable to select
locale DateTimePickerLocale locale is used to translate labels and must to be imported from flutter_cupertino_date_picker package
format String The format of value inserted in 'value' param
pickerFormat String Add a placeholder to input
value String Add a default value to input
onDone Function(String) Callback function called when select date. It will return with same format of param 'format'

Time

This input uses flutter_cupertino_date_picker to manage state and formatters on Time picker.

InputSheet(context).time(
    minDateTime: DateTime.now().subtract(Duration(hours: 5)),
    maxDateTime: DateTime.now().add(Duration(hours: 5)),
    locale: DateTimePickerLocale.en_us,
    format: "HH:mm",
    pickerFormat: "HH|mm",
    minuteDivider: 15,
    value: _value,
    onDone: (String value) => setState(() {
        _value = value;
    }),
);
Parameters Type Description
minDateTime DateTime Min date available to select
maxDateTime DateTime Max date abailable to select
locale DateTimePickerLocale locale is used to translate labels and must to be imported from flutter_cupertino_date_picker package
format String The format of value inserted in 'value' param
pickerFormat String Add a placeholder to input
minuteDivider int Time between each minute option
value String Add a default value to input
onDone Function(String) Callback function called when select date. It will return with same format of param 'format'

Date and Time

This input uses flutter_cupertino_date_picker to manage state and formatters on DateTime picker.

InputSheet(context).datetime(
    minDateTime: DateTime.now(),
    maxDateTime: DateTime.now().add(Duration(days: 7)),
    locale: DateTimePickerLocale.en_us,
    format: "yyyy-MM-dd HH:mm",
    pickerFormat: "yyyy/MM/dd|HH|mm",
    minuteDivider: 15,
    value: _value,
    onDone: (String value) => setState(() {
        _value = value;
    }),
);
Parameters Type Description
minDateTime DateTime Min date available to select
maxDateTime DateTime Max date abailable to select
locale DateTimePickerLocale locale is used to translate labels and must to be imported from flutter_cupertino_date_picker package
format String The format of value inserted in 'value' param
pickerFormat String Add a placeholder to input
minuteDivider int Time between each minute option
value String Add a default value to input
onDone Function(String) Callback function called when select date. It will return with same format of param 'format'

Options

This input implements options to select


InputSheet(context).options(
    options: { '0':'Chocolate' ,'1':'Vanilla', '2':'Strawberry'},
    value: _value,
    onDone: (String value) => setState(() {
        _value = value;
    }),
);
Parameters Type Description
options Map<String, String> A map with value-key pair to be selected as an option
value String A default selected key of options
onDone Function(String) Callback function called when select an option. It will return the selected key option

Multi Options

This input implements options to multiple selections


InputSheet(context).multioptions(
    options: { '0':'Comedy' ,'1':'Romance', '2':'Action'},
    value: _value,
    onDone: (List<String> value) => setState(() {
        _value = value;
    }),
);
Parameters Type Description
options Map<String, String> A map with value-key pair to be selected as an option
value List<String> A list of selected keys of options
onDone Function(List<String>) Callback function called when select an option. It will return the list of selected keys options
optionTextStyle TextStyle A customized style to list tile option label
optionSelectedIcon Icon A customized icon for selected option
optionUnselectedIcon Icon A customized icon for unselected option

Photo

This input use camera to handle camera and need to be imported in your project to pass the parameter resolution and perform your camera quality.

The photo input already handler user permission to access camera.

InputSheet(context).photo(
    url: "url/to/preview/image",
    file: new File("path/to/your/photo"),
    height: 300,
    resolution: ResolutionPreset.high,
    labelInitializingCamera: "Unitializing camera...",
    labelNoCameraAvailable: "There is no camera available on this device",
    onDone: (File file, Uint8List thumbnail) => setState(() {
        _value = file;
        _thumb = thumbnail;
    }),
);
Parameters Type Description
url String The uploaded url file to preview the input photo
file File The local file who will be edited and used as local preview
height double The height of sheet, by default it uses all screen height
resolution ResolutionPreset ResolutionPreset is uset to manage camera quality and must to be imported from camera package
labelInitializingCamera String A default message to show until camera initialize
labelNoCameraAvailable String A default message to show when has no camera available
onDone Function(File, file, Uint8List thumbnail) Callback function called when photo is captured. It will return the file of image and an Uint8List as memory thumbnail

Video

This input use camera to handle camera and need to be imported in your project to pass the parameter resolution and perform your camera quality.

The video input also use video_compress to convert video if neccessary and perform it to reproduce in any web codec environment.

The video input already handle user permission to access camera and mic.

InputSheet(context).video(
    url: "url/to/preview/video",
    file: new File("path/to/your/video"),
    height: 300,
    resolution: ResolutionPreset.high,
    labelInitializingCamera: "Unitializing camera...",
    labelNoCameraAvailable: "There is no camera available on this device",
    timeRecordLimit: 60,
    sufixRecordTimeout: "Sec remaining "
    compress: VideoQuality.DefaultQuality,
    labelCompressing: "Converting video...",
    onDone: (File file, Uint8List thumbnail) => setState(() {
        _value = file;
        _thumb = thumbnail;
    }),
);
Parameters Type Description
url String The uploaded url file to preview the input video
file File The local file who will be edited and used as local preview
height double The height of sheet, by default it uses all screen height
resolution ResolutionPreset ResolutionPreset is uset to manage camera quality and must to be imported from camera package
labelInitializingCamera String A default message to show until camera initialize
labelNoCameraAvailable String A default message to show when has no camera available
timeRecordLimit int The time limit to record video
sufixRecordTimeout String The label suffix to remaining record time
compress VideoQuality VideoQuality is optional. Is used to convert video after stop recording and must to be imported from video_compress package
labelCompressing String If compress is informed, this message will apper on screen to inform the video conversion.
onDone Function(File, file, Uint8List thumbnail) Callback function called when photo is captured. It will return the file of image and an Uint8List as memory thumbnail

🎉 Acknowledgment

Thanks to all the projects that make this package possible. Especially those that facilitate the management of inputs:

  • https://pub.dev/packages/camera
  • https://pub.dev/packages/video_compress
  • https://pub.dev/packages/video_player
  • https://pub.dev/packages/flutter_masked_text
  • https://pub.dev/packages/permission_handler
  • https://pub.dev/packages/flutter_cupertino_date_picker

License

License: MIT

Copyright (c) 2020 André Ciornavei

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

카테고리

의존성

의존성 목록 17 개

소스 저장소

이 패키지를 사용하는 프로젝트

아직 데이터가 없습니다.