tree: 182063f73d6c4d45dd199b4da4c1d082ed5910e7 [path history] [tgz]
  1. example/
  2. lib/
  3. test/
  4. .gitignore
  5. .metadata
  6. AUTHORS
  7. CHANGELOG.md
  8. dart_test.yaml
  9. LICENSE
  10. pubspec.yaml
  11. README.md
packages/two_dimensional_scrollables/README.md

Two Dimensional Scrollables

A package that provides widgets that scroll in two dimensions, built on the two-dimensional foundation of the Flutter framework.

Features

This package provides support for a TableView widget that scrolls in both the vertical and horizontal axes.

TableView

TableView is a subclass of TwoDimensionalScrollView, building its provided children lazily in a TwoDimensionalViewport. This widget can

  • Scroll diagonally, or lock axes
  • Apply decorations to rows and columns
  • Handle gestures & custom pointers for rows and columns
  • Pin rows and columns

Getting started

Depend on it

Run this command with Flutter:

$ flutter pub add two_dimensional_scrollables

Import it

Now in your Dart code, you can use:

import 'package:two_dimensional_scrollables/two_dimensional_scrollables.dart';

Usage

TableView

The code in example/ shows a TableView of initially 400 cells, each varying in sizes with a few TableSpanDecorations like background colors and borders. The builder constructor is called on demand for the cells that are visible in the TableView. Additional rows can be added on demand while the vertical position can jump between the first and last row using the buttons at the bottom of the screen.

Changelog

See the Changelog for a list of new features and breaking changes.

Roadmap

See the GitHub project for a prioritized list of feature requests and known issues.

Additional information

The package uses the two-dimensional foundation from the Flutter framework, meaning most of the core functionality of 2D scrolling is not implemented here. This also means any subclass of the foundation can create different 2D scrolling widgets and be added to the collection. If you want to contribute to this package, you can open a pull request in Flutter Packages and add the tag “p: two_dimensional_scrollables”.