Release 0.0.1

Author: tinyjin

.pubignore

@@ -0,0 +1,28 @@
+.dart_tool/
+.flutter-plugins-dependencies
+.idea/
+.metadata
+.vscode/
+.git/
+.github/
+*.iml
+*.log
+build/
+coverage/
+pubspec.lock
+
+# Examples
+example/assets
+example/android
+example/ios
+example/macos
+example/web
+example/linux
+example/windows
+example/.dart_tool/
+example/build/
+example/pubspec.lock
+example/.flutter-plugins-dependencies
+
+# README assets
+assets/

README.md

@@ -1,9 +1,9 @@
 # Sticker Widget
 
-Fully customizable core sticker widgets you can drop into any flutter app.
+Draggable, rotatable, resizable and customizable sticker widgets for Flutter.
 
 <p align="center">
-  <img src="https://github.com/blossomdiary/sticker_widget/raw/main/docs/thumbnail.png" alt="demo" />
+  <img src="https://github.com/blossomdiary/sticker_widget/raw/main/assets/thumbnail.png" alt="demo" />
 </p>
 
 ## Features

docs/thumbnail.png assets/thumbnail.pngdocs/thumbnail.png renamed to assets/thumbnail.png

@@ -1,13 +1,24 @@
+/// Model describing an image sticker.
 class PictureModel {
+  /// Image URL or asset path.
   String stringUrl;
+
+  /// Top position inside the sticker bounds.
   double top;
+
+  /// Whether the sticker is currently selected.
   bool isSelected;
+
+  /// Rotation in radians.
   double angle;
 
-  /// Scale image
+  /// Scale factor for the image.
   double scale;
+
+  /// Left position inside the sticker bounds.
   double left;
 
+  /// Creates a picture sticker model.
   PictureModel(
       {required this.stringUrl,
       required this.top,
@@ -16,6 +27,7 @@ class PictureModel {
       required this.scale,
       required this.left});
 
+  /// Creates a picture sticker from a URL or asset path.
   factory PictureModel.fromUrl(
     String url, {
     double top = 0,
@@ -34,6 +46,7 @@ class PictureModel {
     );
   }
 
+  /// Creates a model from a JSON map.
   PictureModel.fromJson(Map<String, dynamic> data)
       : stringUrl = data['url'] ?? '',
         top = data['top'] ?? 0,
@@ -42,6 +55,7 @@ class PictureModel {
         scale = data['scale'] ?? 1,
         isSelected = false;
 
+  /// Serializes the model to JSON.
   Map<String, dynamic> toJson() {
     return {
       'url': stringUrl,

lib/src/model/picture_model.dart

@@ -1,15 +1,32 @@
 import 'package:flutter/material.dart';
 
+/// Model describing a text sticker.
 class TextModel {
+  /// Displayed text.
   String name;
+
+  /// Text style for rendering.
   TextStyle textStyle;
+
+  /// Top position inside the sticker bounds.
   double top;
+
+  /// Left position inside the sticker bounds.
   double left;
+
+  /// Whether the sticker is currently selected.
   bool isSelected;
+
+  /// Rotation in radians.
   double angle;
+
+  /// Text alignment.
   TextAlign textAlign;
+
+  /// Scale factor for the text.
   double scale;
 
+  /// Creates a text sticker model.
   TextModel(
       {required this.name,
       required this.textStyle,
@@ -20,6 +37,7 @@ class TextModel {
       required this.scale,
       required this.left});
 
+  /// Creates a text sticker from a string.
   factory TextModel.fromText(
     String text, {
     TextStyle? textStyle,
@@ -42,6 +60,7 @@ class TextModel {
     );
   }
 
+  /// Creates a model from a JSON map.
   TextModel.fromJson(Map<String, dynamic> data)
       : name = data['text'] ?? '',
         textStyle = TextStyle(
@@ -65,6 +84,7 @@ class TextModel {
         isSelected = false,
         textAlign = TextAlign.values[data['textAlign'] ?? 0];
 
+  /// Serializes the model to JSON.
   Map<String, dynamic> toJson() {
     return {
       'text': name,

lib/src/model/text_model.dart

@@ -4,6 +4,7 @@ import 'package:flutter/material.dart';
 
 import '../model/picture_model.dart';
 
+/// Editable sticker widget for images.
 class PictureEditingBox extends StatefulWidget {
   /// Your widget should be move within this [boundWidth]
   final double boundWidth;
@@ -20,6 +21,7 @@ class PictureEditingBox extends StatefulWidget {
   /// If you use onTap then you Have to manage IsSelected field in PicturModel
   final Function()? onTap;
 
+  /// Disables interaction when true.
   final bool viewOnly;
 
   /// Custom controller Icons

lib/src/widgets/sticker_box.dart

@@ -5,6 +5,7 @@ import '../model/text_model.dart';
 import 'sticker_box.dart';
 import 'text_box.dart';
 
+/// Wrapper that renders either a picture or text sticker.
 class StickerWidget extends StatelessWidget {
   /// Your widget should be move within this [boundWidth]
   final double boundWidth;
@@ -21,6 +22,7 @@ class StickerWidget extends StatelessWidget {
   /// If you use onTap then you Have to manage IsSelected field in model
   final VoidCallback? onTap;
 
+  /// Disables interaction when true.
   final bool viewOnly;
 
   /// Custom controller Icons
@@ -32,6 +34,7 @@ class StickerWidget extends StatelessWidget {
   /// Custom request to edit text. When provided, the default dialog is skipped.
   final TextEditRequest? onTextEditRequest;
 
+  /// Creates a sticker widget for either a [PictureModel] or [TextModel].
   const StickerWidget({
     super.key,
     required this.boundWidth,

lib/src/widgets/sticker_widget.dart

@@ -3,10 +3,11 @@ import 'package:flutter/material.dart';
 
 import '../model/text_model.dart';
 
+/// Callback for providing a custom text editing flow.
 typedef TextEditRequest =
     Future<String?> Function(BuildContext context, String currentText);
 
-// ignore: must_be_immutable
+/// Editable sticker widget for text.
 class TextEditingBox extends StatefulWidget {
   /// TextModel for your text
   final TextModel textModel;
@@ -17,7 +18,8 @@ class TextEditingBox extends StatefulWidget {
   /// Your widget should be move within this [boundHeight]
   final double boundHeight;
 
-  bool viewOnly;
+  /// Disables interaction when true.
+  final bool viewOnly;
 
   /// Custom controller Icons
   final Icon? editIcon;

lib/src/widgets/text_box.dart

@@ -1,3 +1,4 @@
+/// Sticker widgets and models for draggable, resizable, rotatable content.
 library;
 
 export 'src/model/picture_model.dart';

lib/sticker_widget.dart

@@ -1,7 +1,14 @@
 name: sticker_widget
-description: "A new Flutter package project."
+description: Draggable, rotatable, and resizable sticker widgets for Flutter.
 version: 0.0.1
-homepage:
+homepage: https://blossomdiary.dev
+repository: https://github.com/blossomdiary/sticker_widget
+topics:
+  - sticker
+  - widget
+  - editor
+  - image
+  - text
 
 environment:
   sdk: ^3.10.7