v0.0.1

divshekhar · divshekhar · commit 001b6bef7a2b · 2022-04-01T09:51:50.000+05:30
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,4 @@
+# Every request must be reviewed and accepted by:
+
+* @skpraharaj
+* @divshekhar
diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md
@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Logs **
+Run `flutter analyze` and attach any output of that command below.
+If there are any analysis errors, try resolving them before filing this issue.
+
+Paste the output of running `flutter doctor -v` here.
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is.
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,31 @@
+<!--
+  Thanks for contributing!
+
+  Provide a description of your changes below and a general summary in the title
+
+  Please look at the following checklist to ensure that your PR can be accepted quickly:
+-->
+
+## Status
+
+**READY/IN DEVELOPMENT/HOLD**
+
+## Breaking Changes
+
+YES | NO
+
+## Description
+
+<!--- Describe your changes in detail -->
+
+## Type of Change
+
+<!--- Put an `x` in all the boxes that apply: -->
+
+- [ ] ✨ New feature (non-breaking change which adds functionality)
+- [ ] 🛠️ Bug fix (non-breaking change which fixes an issue)
+- [ ] ❌ Breaking change (fix or feature that would cause existing functionality to change)
+- [ ] 🧹 Code refactor
+- [ ] ✅ Build configuration change
+- [ ] 📝 Documentation
+- [ ] 🗑️ Chore
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,23 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      # Setup the flutter environment.
+      - uses: subosito/flutter-action@v2.3.0
+
+      - name: Install Dependencies
+        run: flutter packages get
+
+      - name: Format
+        run: flutter format --set-exit-if-changed lib
+
+      - name: Analyze
+        run: flutter analyze --no-pub
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,4 @@
 ## 0.0.1
 
+* Initial Release
 * Fully functional bulletin widget.
diff --git a/LICENSE b/LICENSE
@@ -1 +1,27 @@
-TODO: Add your license here.
+BSD 3-Clause License
+
+(c) Copyright 2022 DevsOnFlutter
+
+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.
diff --git a/README.md b/README.md
@@ -6,11 +6,14 @@ Flutter package to to show bulletins in your application.
 
 ## Show some :heart: and :star: the repo
 
-<!-- ## Demo -->
+|<img height=500 src="https://i.imgur.com/suiSFeN.png"/>|
 
 ## Features
 
-TODO: List what your package can do. Maybe include images, gifs, or videos.
+✅ Show Flash Cards
+✅ Pop up cards
+✅ Animation flash cards
+✅ Fully Customizable
 
 ## Getting started
 
@@ -20,46 +23,46 @@ Include plugin to your project
 dependencies:
   bulletin: <latest version>
 ```
+
 Run `pub get` and get packages.
 
 ## Example
+
 Go to example section in pub.dev to see the full example code.
 
 In GitHub, head over to `example/lib/main.dart` to see the full example code.
 
-|<img height=500 src="https://i.imgur.com/suiSFeN.png"/>|
-
 ```dart
 Bulletin(
-                icon: const Icon(
-                  Icons.mic_outlined,
-                  size: 20,
-                ),
-                backgroundColor: const Color(0xffFFF3D0),
-                children: [
-                  BulletinItem(
-                    text:
-                        "1. This is a bulletin.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi eget elementum libero.",
-                    onTap: () {
-                      debugPrint("OnTap Function called for BulletinItem 1 ");
-                    },
-                  ),
-                  BulletinItem(
-                    text:
-                        "2. This is a bulletin.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi eget elementum libero.",
-                    onTap: () {
-                      debugPrint("OnTap Function called for BulletinItem 2 ");
-                    },
-                  ),
-                  BulletinItem(
-                    text:
-                        "3. This is a bulletin.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi eget elementum libero.",
-                    onTap: () {
-                      debugPrint("OnTap Function called for BulletinItem 3 ");
-                    },
-                  ),
-                ],
-              ),
+  icon: const Icon(
+    Icons.mic_outlined,
+    size: 20,
+  ),
+  backgroundColor: const Color(0xffFFF3D0),
+  children: [
+    BulletinItem(
+      text:
+          "1. This is a bulletin.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi eget elementum libero.",
+      onTap: () {
+        debugPrint("OnTap Function called for BulletinItem 1 ");
+      },
+    ),
+    BulletinItem(
+      text:
+          "2. This is a bulletin.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi eget elementum libero.",
+      onTap: () {
+        debugPrint("OnTap Function called for BulletinItem 2 ");
+      },
+    ),
+    BulletinItem(
+      text:
+          "3. This is a bulletin.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi eget elementum libero.",
+      onTap: () {
+        debugPrint("OnTap Function called for BulletinItem 3 ");
+      },
+    ),
+  ],
+),
 ```
 
 ## Project Created & Maintained By
@@ -100,5 +103,5 @@ For a custom-hook to be merged, you will need to do the following:
 
 ## Copyright & License
 
-Code and documentation Copyright (c) 2021 [Divyanshu Shekhar](https://hackthedeveloper.com). Code released under the [BSD 3-Clause License](./LICENSE).
+Code and documentation Copyright (c) 2021 [DevsOnFlutter](https://github.com/DevsOnFlutter). Code released under the [BSD 3-Clause License](./LICENSE).
 
diff --git a/lib/src/bulletin.dart b/lib/src/bulletin.dart
@@ -1,9 +1,10 @@
 import 'dart:async';
+import 'package:flutter/material.dart';
 
 import 'package:bulletin/src/bulletin_item.dart';
-import 'package:flutter/material.dart';
 
 class Bulletin extends StatefulWidget {
+  /// Bulletin
   const Bulletin({
     Key? key,
     this.children = const [],
@@ -74,9 +75,9 @@ class Bulletin extends StatefulWidget {
 }
 
 class _BulletinState extends State<Bulletin> with TickerProviderStateMixin {
-  late AnimationController _controller;
-  late ValueNotifier<int> index;
-  late ValueNotifier<bool> isClosed;
+  late final AnimationController _controller;
+  late final ValueNotifier<int> index;
+  late final ValueNotifier<bool> isClosed;
 
   @override
   void initState() {
diff --git a/lib/src/bulletin_item.dart b/lib/src/bulletin_item.dart
@@ -1,15 +1,23 @@
 import 'package:flutter/material.dart';
 
 class BulletinItem {
-  Widget? icon;
-  String text;
-  TextStyle? textStyle;
-  VoidCallback? onTap;
+  /// Icon of the bulletin
+  final Widget? icon;
 
+  /// Text of the bulletin
+  final String text;
+
+  /// Text style of the bulletin
+  final TextStyle? textStyle;
+
+  /// Function called onTap to bulletin
+  final VoidCallback? onTap;
+
+  /// Bulletin Item
   BulletinItem({
-    this.icon,
     required this.text,
-    this.textStyle,
     required this.onTap,
+    this.icon,
+    this.textStyle,
   });
 }
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,5 +1,5 @@
 name: bulletin
-description: A flutter package to show multiple flash cards
+description: A flutter package to show fully customizable multiple animating flash cards
 version: 0.0.1
 repository: https://github.com/DevsOnFlutter/bulletin
 
@@ -11,45 +11,9 @@ dependencies:
   flutter:
     sdk: flutter
 
-
 dev_dependencies:
   flutter_test:
     sdk: flutter
   flutter_lints: ^1.0.0
 
-# For information on the generic Dart part of this file, see the
-# following page: https://dart.dev/tools/pub/pubspec
-
-# The following section is specific to Flutter.
 flutter:
-
-  # To add assets to your package, add an assets section, like this:
-  # assets:
-  #   - images/a_dot_burr.jpeg
-  #   - images/a_dot_ham.jpeg
-  #
-  # For details regarding assets in packages, see
-  # https://flutter.dev/assets-and-images/#from-packages
-  #
-  # An image asset can refer to one or more resolution-specific "variants", see
-  # https://flutter.dev/assets-and-images/#resolution-aware.
-
-  # To add custom fonts to your package, add a fonts section here,
-  # in this "flutter" section. Each entry in this list should have a
-  # "family" key with the font family name, and a "fonts" key with a
-  # list giving the asset and other descriptors for the font. For
-  # example:
-  # fonts:
-  #   - family: Schyler
-  #     fonts:
-  #       - asset: fonts/Schyler-Regular.ttf
-  #       - asset: fonts/Schyler-Italic.ttf
-  #         style: italic
-  #   - family: Trajan Pro
-  #     fonts:
-  #       - asset: fonts/TrajanPro.ttf
-  #       - asset: fonts/TrajanPro_Bold.ttf
-  #         weight: 700
-  #
-  # For details regarding fonts in packages, see
-  # https://flutter.dev/custom-fonts/#from-packages

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
`1`	`1`	`## 0.0.1`
`2`	`2`
	`3`	`+* Initial Release`
`3`	`4`	`* Fully functional bulletin widget.`