timeline 0.0.1

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • new79

Timeline

A flutter package that allows you to create basic timelines on your flutter application. This is customizable and easy to plugin to your application. You will find the following features:

  • A simple timeline with a title and a description
  • Customizable color options for - Line, Title, Description and Background
  • Tween animation on the line
  • Title will be truncated at 47 characters to prevent overflowing
  • Description will be truncated at 75 character to prevent overflowing

Getting Started

You will need to add the following dependency in your pubspec.yaml file to download the depedency.

dependencies:
  flutter:
    sdk: flutter
  timeline: 0.0.1

Note: This was built on the following tools.

  • Flutter - v0.4.4
  • Dart - v2.0.0-dev.54.0

Usage

You will need to create a list of TimelineModel first. This creates an instance with an id which is a String at the moment, along with title and description

Example

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Authors

  • Rejish Radhakrishnan

License

Copyright 2018 Rejish Radhakrishnan

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

[0.0.4] - Release

  • A very basic timeline to display a series of events in the provided order.

[0.0.3] - Pre release

  • Identifying the first and last elements of the list and paint accordingly. Tagged to pre-release for consumption.

[0.0.2] - Pre release

  • Add new timeline component. Tagged to pre-release for consumption.

[0.0.1] - Pre release

  • Initial Commit. Tagged to pre- release for consumption.

example/example.dart

import "package:flutter/material.dart";
import 'package:timeline/model/timeline_model.dart';
import 'package:timeline/timeline.dart';

class TimelineExample extends StatelessWidget {

  final List<TimelineModel> list = [
    TimelineModel(
      id: "1",
      description: "Test 1",
      title: "Test 1"),
      TimelineModel(
      id: "2",
      description: "Test 2",
      title: "Test 2")
  ];

  @override
  Widget build(BuildContext context) {
    return new TimelineComponent(
      timelineList: list,
        // lineColor: Colors.red[200], // Defaults to accent color if not provided
        // backgroundColor: Colors.black87, // Defaults to white if not provided
        // headingColor: Colors.black, // Defaults to black if not provided
        // descriptionColor: Colors.grey, // Defaults to grey if not provided
      );
  }


}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  timeline: "^0.0.1"

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter packages get

Alternatively, your editor might support flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


      import 'package:timeline/timeline.dart';
  
Version Uploaded Documentation Archive
0.0.1 Jun 27, 2018 Go to the documentation of timeline 0.0.1 Download timeline 0.0.1 archive

Analysis

We analyzed this package on Jul 13, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0-dev.63.0
  • pana: 0.11.3
  • Flutter: 0.5.4

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
59 / 100
Health:
Code health derived from static analysis. [more]
98 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100 / 100
Overall score:
Weighted score of the above. [more]
79
Learn more about scoring.

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Suggestions

  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 4 hints.

    Run flutter format to format lib/model/timeline_model.dart.

    Run flutter format to format lib/timeline.dart.

    Similar analysis of the following files failed:

    • lib/timeline_element.dart (hint)
    • lib/timeline_painter.dart (hint)

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.54.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.6 1.14.10
meta 1.1.5
sky_engine 0.0.99
typed_data 1.1.5
vector_math 2.0.6 2.0.7
Dev dependencies
flutter_test