Flutter Shine 项目教程

Flutter Shine 项目教程

flutter_shine.dartFlutter Shine is a library for pretty and realistic shadows, dynamic light positions, extremely customizable shadows, no library dependencies, text or box shadows based on content.项目地址:https://gitcode.com/gh_mirrors/fl/flutter_shine.dart

1、项目的目录结构及介绍

Flutter Shine 项目的目录结构如下：

flutter_shine/
├── images/
├── packages/
│   └── flutter_shine/
├── scripts/
├── travis.yml
├── LICENSE
├── README.md
├── analysis_options.yml

目录介绍

• images/: 存放项目相关的图片资源。
• packages/flutter_shine/: 项目的核心代码目录，包含库的主要实现。
• scripts/: 存放项目构建和部署相关的脚本。
• travis.yml: Travis CI 配置文件，用于持续集成。
• LICENSE: 项目的许可证文件，本项目采用 MIT 许可证。
• README.md: 项目说明文档，包含项目的基本介绍和使用方法。
• analysis_options.yml: 代码分析配置文件，用于代码风格和质量检查。

2、项目的启动文件介绍

项目的启动文件是 packages/flutter_shine/lib/flutter_shine.dart，该文件是 Flutter Shine 库的入口点。

// packages/flutter_shine/lib/flutter_shine.dart

import 'package:flutter/material.dart';
import 'flutter_shine.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: Center(
          child: FlutterShine(
            builder: (BuildContext context, ShineShadow shineShadow) {
              return Column(
                crossAxisAlignment: CrossAxisAlignment.center,
                mainAxisAlignment: MainAxisAlignment.spaceEvenly,
                mainAxisSize: MainAxisSize.max,
                children: <Widget>[
                  Text(
                    "Shine",
                    style: TextStyle(
                      fontSize: 100,
                      color: Colors.white,
                      shadows: shineShadow.shadows,
                    ),
                  ),
                  Divider(),
                  Container(
                    width: 300,
                    height: 300,
                    decoration: BoxDecoration(
                      color: Colors.white,
                      boxShadow: shineShadow.boxShadows,
                    ),
                  ),
                ],
              );
            },
          ),
        ),
      ),
    );
  }
}

启动文件介绍

• main(): 应用程序的入口函数，调用 runApp 启动应用。
• MyApp: 应用的主组件，继承自 StatelessWidget，构建应用的界面。
• FlutterShine: 核心组件，用于生成动态阴影效果。

3、项目的配置文件介绍

项目的配置文件主要包括 analysis_options.yml 和 travis.yml。

analysis_options.yml

该文件用于配置代码分析规则，确保代码风格和质量。

# analysis_options.yml

include: package:pedantic/analysis_options.yaml

analyzer:
  strong-mode:
    implicit-casts: false
    implicit-dynamic: false

linter:
  rules:
    - always_declare_return_types
    - avoid_empty_else
    - avoid_init_to_null
    - avoid_unused_constructor_parameters
    - camel_case_types
    - empty_constructor_bodies
    - library_prefixes
    - non_constant_identifier_names
    - one_member_abstracts
    - prefer_final_fields
    - prefer_initializing_formals
    - slash_for_doc_comments
    - sort_constructors_first
    - sort_unnamed_constructors_first
    - super_goes_last
    - type_init_formals
    - unnecessary_brace_in_string_interps
    - unnecessary_const
    - unnecessary_new
    - unnecessary_this
    - unrelated_type_equality_checks
    - valid_regexps

travis.yml

该文件用于配置 Travis CI，实现持续集成。

# travis.yml

language: dart

dart:
  - stable

script:
  - dart pub get
  - dart analyze
  - dart test

notifications:
  email:
   

flutter_shine.dartFlutter Shine is a library for pretty and realistic shadows, dynamic light positions, extremely customizable shadows, no library dependencies, text or box shadows based on content.项目地址:https://gitcode.com/gh_mirrors/fl/flutter_shine.dart