搜索插件、代码仓与 APP 分类

插件详情v0.2.1

input_sheet

一个 Flutter 包,帮助具有大量表单的应用程序,将输入项实现为 BottomSheet,使其更加愉悦。

近 30 天下载
45
喜欢数
46
Pub 分数
40

安装插件

flutter pub add input_sheet

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

InputSheet 是一个 Flutter 包,旨在通过在 BottomSheet 中呈现输入项来提升表单输入体验,从而改善具有大量表单的应用程序的可用性。它提供了一个简洁直观的界面,可适应不同的输入类型,确保在移动设备上获得流畅的用户体验。BottomSheet 方法保持表单的可访问性,同时不会使主屏幕变得杂乱,非常适合数据密集型应用程序。它可无缝集成到现有的 Flutter 项目中,并支持响应式设计原则。

适合场景

  • 长格式数据输入
  • 以移动设备为先的表单界面
  • 减少屏幕杂乱
  • 增强输入可访问性
  • 通过表单提升用户参与度

主要特点

  • 基于 BottomSheet 的输入布局
  • 支持多种输入类型
  • 与 Flutter 表单的轻松集成
  • 响应式和自适应设计
  • 可自定义的外观和行为

适合对象

  • 移动应用开发者
  • 表单密集型应用
  • 以用户体验为中心的UI设计
  • 注重可访问性的开发
  • 需要简化输入流程的应用程序

使用建议

  • 仅限移动平台
  • 需要手动处理表单状态
  • 复杂布局可能需要额外的样式
  • 依赖于 Flutter 的 BottomSheet 小部件
  • 不适用于桌面或Web使用

原始 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 项

源码仓库

使用此插件的项目

暂无相关数据。