Merge pull request #53 from tarkalabs/rajiv/to-adhere-pub-dev-standards

To adhere pub dev standards

CHANGELOG.md

@@ -1,38 +1,9 @@
+## 1.1.2 - 2024-02-24
+
+* Fixes: Adhere to pub.dev package standards and updated documentation.
+
 ## 1.1.1 - 2024-02-24
 
-* Added components:
-TUIAccordion
-TUIAnchor
-TUIAppTopBar
-TUIAttachmentUpload
-TUIAvatar
-TUIBadge
-TUIBreadCrumb
-TUIButton
-TUICheckBox
-TUICheckBoxRow
-TUIChip
-TUIDivider
-TUIDraggableCard
-TUIEmailField
-TUIEmailSubjectField
-TUIFloatingActionButton
-TUIIconButton
-TUIInputField
-TUIMediaThumbnail
-TUIMenuItem
-TUIMobileButtonBlock
-TUIMobileOverlayHeader
-TUIMobileOverlayFooter
-TUINavigationRow
-TUIRadioButton
-TUIRangeSlider
-TUISearchBar
-TUISelectionCard
-TUISlider
-TUISnackBar
-TUISuccessCheckMark
-TUIToggleSwitch
-TUITag
-TUIToggleRow
+* Initial release of the Tarka UI library with 33 components.
+
 

LICENSE

@@ -14,7 +14,7 @@ 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
+FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 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

README.md

@@ -12,7 +12,7 @@ and the Flutter guide for
 -->
 
 # Tarka UI Kit Flutter
-Tarka UI Kit is a reusable component library for building Flutter apps, based on a design system using Atomic Design principles
+Tarka UI Kit is a pre-built component library for building Flutter apps. It is based on our design system, utilizing Atomic Design principles.
 
 # List of components
 - TUIAccordion
@@ -50,17 +50,6 @@ Tarka UI Kit is a reusable component library for building Flutter apps, based on
 - TUITag
 - TUIToggleRow
 
-
-## How to use this package in your project?  
-
-```
-# Add this below package in the dependencies section of the pubspec.yaml file
-tarka_ui:
-    git:
-      url: [email protected]:tarkalabs/tarka-ui-kit-flutter.git
-      ref: v1.1.0
-```
-
 ## How to run the kitchen sink app?
 
 ### From Android Studio

example/README.md

@@ -1,16 +1,4 @@
 # example
 
-Tarka Kit Flutter example project
+Tarka UI Kit Flutter example project
 
-## Getting Started
-
-This project is a starting point for a Flutter application.
-
-A few resources to get you started if this is your first Flutter project:
-
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
-
-For help getting started with Flutter development, view the
-[online documentation](https://docs.flutter.dev/), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.

example/lib/styles/colors.dart

@@ -64,4 +64,4 @@ class AppColors {
   static const Color errorHover = Color(0xffDF2036);
   static const Color warningHover = Color(0xffFFAD14);
   static const Color disabledBackgroundHover = Color(0x331A1B1F);
-}
+}

example/lib/symbol.dart

@@ -22,6 +22,7 @@ enum Symbol {
   sync(FluentIcons.arrow_sync_circle_24_regular),
   tabs(FluentIcons.tabs_24_regular),
   hamburgerMenu(FluentIcons.line_horizontal_3_20_filled);
+
   final IconData value;
 
   const Symbol(this.value);

example/pubspec.lock

@@ -179,7 +179,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.1.0"
+    version: "1.1.1+1"
   term_glyph:
     dependency: transitive
     description:

lib/components/accordion/accordion.dart

@@ -4,14 +4,14 @@ import 'package:tarka_ui/styles/default_colors.dart';
 import 'package:tarka_ui/styles/theme.dart';
 
 /// TUIAccordion is a widget that allows you to show and hide content.
-/*
-  Example:
-    ```dart
-  TUIAccordion(
-    title: 'Accordion Title',
-    subtitle: 'Accordion Subtitle',
-  ),```
- */
+///
+/// Example:
+///     ```dart
+///   TUIAccordion(
+///     title: 'Accordion Title',
+///     subtitle: 'Accordion Subtitle',
+///   )
+/// ```
 class TUIAccordion extends StatefulWidget {
   final String title;
   final String subtitle;

lib/components/anchor/anchor.dart

@@ -2,17 +2,16 @@ import 'package:flutter/material.dart';
 import 'package:tarka_ui/styles/theme.dart';
 
 /// TUIAnchor is a component that is used to create a clickable anchor.
-/*
-  Example:
-  ```dart
-  TUIAnchor(
-    title: 'Anchor',
-    onPressed: () {
-      print('Anchor pressed');
-    },
-  )
-  ```
-*/
+///
+/// Example:
+/// ```dart
+/// TUIAnchor(
+///     title: 'Anchor',
+///     onPressed: () {
+///       print('Anchor pressed');
+///     },
+///   )
+/// ```
 class TUIAnchor extends StatefulWidget {
   const TUIAnchor({
     super.key,

lib/components/app_bar/app_bar.dart

@@ -2,20 +2,21 @@ import 'package:flutter/material.dart';
 import 'package:tarka_ui/styles/theme.dart';
 
 /// TUIAppTopBar is a widget that allows you to create a top bar.
-/*
-Example:
-```dart
-TUIAppTopBar(
-  items: [
-    TUIAppBarItem(iconData: Icons.home, label: "Home", tooltip: "Home"),
-    TUIAppBarItem(iconData: Icons.search, label: "Search", tooltip: "Search"),
-    TUIAppBarItem(iconData: Icons.person, label: "Profile", tooltip: "Profile"),
-  ],
-  onTap: (index) {
-    print("TUIAppTopBar: $index");
-  },
-  currentIndex: 0,
- */
+///
+/// Example:
+/// ```dart
+///  TUIAppTopBar(
+///   items: [
+///     TUIAppBarItem(iconData: Icons.home, label: "Home", tooltip: "Home"),
+///     TUIAppBarItem(iconData: Icons.search, label: "Search", tooltip: "Search"),
+///     TUIAppBarItem(iconData: Icons.person, label: "Profile", tooltip: "Profile"),
+///   ],
+///   onTap: (index) {
+///     print("TUIAppTopBar: $index");
+///   },
+///   currentIndex: 0,
+///  )
+/// ```
 class TUIAppTopBar extends StatefulWidget {
   final List<TUIAppBarItem> items;
   final List<BottomNavigationBarItem> _bnbItems;

lib/components/attachment_upload/attachment_upload.dart

@@ -4,22 +4,22 @@ import 'package:tarka_ui/styles/theme.dart';
 import 'package:tarka_ui/subcomponents/image.dart';
 
 /// TUIAttachmentUpload widget to display an attachment upload with title, description and action buttons.
-
-/*
-Example:
-```dart
-TUIAttachmentUpload(
-  title: "Attachment 1",
-  isIconUsed: true,
-  icon: FluentIcons.attach_12_regular,
-  description: "Description of attachment 1",
-  downloadTapped: () {
-    print("Download tapped");
-  },
-  deleteTapped: () {
-    print("Delete tapped");
-  },
- */
+///
+/// Example:
+/// ```dart
+/// TUIAttachmentUpload(
+///   title: "Attachment 1",
+///   isIconUsed: true,
+///   icon: FluentIcons.attach_12_regular,
+///   description: "Description of attachment 1",
+///   downloadTapped: () {
+///     print("Download tapped");
+///   },
+///   deleteTapped: () {
+///     print("Delete tapped");
+///   },
+///  )
+///  ```
 class TUIAttachmentUpload extends StatelessWidget {
   final String title;
   final bool isIconUsed;

lib/components/avatar/avatar.dart

@@ -4,20 +4,21 @@ import 'package:tarka_ui/styles/text_style.dart';
 import 'package:tarka_ui/subcomponents/image.dart';
 
 /// TUIAvatar is used to create a Avatar with content, size and badge flag.
-/*
-  Example:
-    ```dart
-  TUIAvatar(
-    avatarSize: TUIAvatarSize.xs,
-    avatarContent: TUIAvatarContent(
-      type: TUIAvatarContentType.image,
-      image: TUIImage(
-        imageUrl: 'https://picsum.photos/200/300',
-      ),
-    ),
-    isBadged: true,
-  ),```
- */
+///
+///   Example:
+///     ```dart
+///   TUIAvatar(
+///     avatarSize: TUIAvatarSize.xs,
+///     avatarContent: TUIAvatarContent(
+///       type: TUIAvatarContentType.image,
+///       image: TUIImage(
+///         imageUrl: 'https://picsum.photos/200/300',
+///       ),
+///     ),
+///     isBadged: true,
+///   )
+///   ```
+
 class TUIAvatar extends StatelessWidget {
   final TUIAvatarSize avatarSize;
   final TUIAvatarContent avatarContent;

lib/components/badge/badge.dart

@@ -60,16 +60,15 @@ enum TUIBadgeSize {
 }
 
 /// TUIBadge is used to create a Badge with content, size and badge flag.
-/*
-  Example:
-  ```dart
-  TUIBadge(
-    badgeSize: TUIBadgeSize.xs,
-    content: '1',
-    isNumbered: true,
-  ),
-  ```
- */
+///
+///  Example:
+///  ```dart
+///  TUIBadge(
+///    badgeSize: TUIBadgeSize.xs,
+///    content: '1',
+///    isNumbered: true,
+///  ),
+///  ```
 class TUIBadge extends StatelessWidget {
   final TUIBadgeSize badgeSize;
   final String? content;
@@ -114,4 +113,4 @@ class TUIBadge extends StatelessWidget {
       );
     }
   }
-}
+}

lib/components/breadcrumb/breadcrumb.dart

@@ -3,16 +3,16 @@ import 'package:tarka_ui/styles/default_colors.dart';
 import 'package:tarka_ui/styles/theme.dart';
 
 /// TUIBreadCrumb is used to create a BreadCrumb with titles and onTap function.
-/*
-  Example:
-    ```dart
-  TUIBreadCrumb(
-    titles: ['Home', 'Library', 'Data'],
-    onTap: (index) {
-      print('Tapped on index: $index');
-    },
-  ),```
- */
+///
+///  Example:
+///    ```dart
+///  TUIBreadCrumb(
+///    titles: ['Home', 'Library', 'Data'],
+///    onTap: (index) {
+///      print('Tapped on index: $index');
+///    },
+///  )
+///  ```
 class TUIBreadCrumb extends StatelessWidget {
   final Function(int) onTap;
   final List<String> titles;

lib/components/button/button.dart

@@ -3,17 +3,17 @@ import 'package:tarka_ui/components/button/style.dart';
 import 'package:tarka_ui/styles/theme.dart';
 
 /// TUIButton is used to create a button with label, icon and button type.
-/*
-  Example:
-    ```dart
-  TUIButton(
-    type: TUIButtonType.primary,
-    size: TUIButtonSize.m,
-    label: 'Primary',
-    onPressed: () {},
-  ),
-   ```
- */
+///
+///  Example:
+///    ```dart
+///  TUIButton(
+///    type: TUIButtonType.primary,
+///    size: TUIButtonSize.m,
+///    label: 'Primary',
+///    onPressed: () {},
+///  )
+///   ```
+
 class TUIButton extends StatelessWidget {
   const TUIButton({
     super.key,
@@ -25,7 +25,7 @@ class TUIButton extends StatelessWidget {
     required this.onPressed,
     this.onLongPress,
     this.height,
-  })  : assert(label != null || iconData != null);
+  }) : assert(label != null || iconData != null);
 
   final TUIButtonType type;
   final TUIButtonSize size;