flutter_fotoflex 0.0.1

A Flexible Image View

FotoFlex Widget Documentation

Overview

FotoFlex is a customizable Flutter widget designed to display a horizontally scrollable list of images. It allows users to dynamically manage an image collection, including adding new images and deleting existing ones. This document guides you through the process of implementing and using FotoFlex in your Flutter application.

Features

• Horizontally scrollable image list.
• Add and delete image functionalities.
• Customizable dimensions and border color.
• Placeholder display when the image list is empty.

Installation

Before using FotoFlex, ensure you have Flutter installed in your environment. To include FotoFlex in your project, add the following dependency to your pubspec.yaml file:

dependencies:
  flutter:
    sdk: flutter
  # Add other dependencies required by your project
  flutter_fotoflex: ^0.0.1

Usage

Here's a step-by-step guide to implementing the FotoFlex widget:

Step 1: Import the Widget

Import FotoFlex into your Dart file:

import 'package:flutter_fotoflex/flutter_fotoflex.dart';

Step 2: Initialize FotoFlex

Declare and initialize the FotoFlex widget:

FotoFlex(
  width: 300.0,
  height: 200.0,
  handleDelete: (int index) {
    // Implement delete logic
  },
  handleAddMoreImages: () {
    // Implement add more images logic
  },
  handlePlaceholder: () {
    // Implement placeholder logic
  },
  borderColor: Colors.blue,
  listImages: [/* List of File objects */],
)

Step 3: Add FotoFlex to Your Widget Tree

Include FotoFlex in your app's widget tree:

@override
Widget build(BuildContext context) {
  return Scaffold(
    appBar: AppBar(
      title: Text('FotoFlex Demo'),
    ),
    body: Center(
      child: FotoFlex(
        // Your FotoFlex initialization
      ),
    ),
  );
}

Customization

You can customize FotoFlex by modifying its properties:

• width and height to set the dimensions of the widget.
• handleDelete to define the action when an image is deleted.
• handleAddMoreImages to specify the action when adding new images.
• handlePlaceholder to handle interactions with the placeholder.
• borderColor to change the border color of the widget.
• listImages to provide the list of images (as File objects).

Example

FotoFlex(
  width: 350.0,
  height: 250.0,
  handleDelete: (int index) {
    // Delete image logic
  },
  handleAddMoreImages: () {
    // Add image logic
  },
  handlePlaceholder: () {
    // Placeholder interaction logic
  },
  borderColor: Colors.red,
  listImages: [File('path/to/image1.jpg'), File('path/to/image2.jpg')],
)

License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.