Add initial scaffolding

.github/workflows/showcase_build.yaml → .github/workflows/samples_build.yaml

@@ -1,32 +1,30 @@
-name: Showcase Build
+name: Samples Build
 
 on:
   workflow_dispatch: {}
   push:
     branches:
       - master
     paths:
-      - .github/workflows/showcase_build.yaml
+      - .github/workflows/samples_build.yaml
       - forui/**
-      - forui_assets/**
-      - showcase/**
+      - samples/**
 
   pull_request:
     branches:
       - master
     paths:
-      - .github/workflows/showcase_build.yaml
+      - .github/workflows/samples_build.yaml
       - forui/**
-      - forui_assets/**
-      - showcase/**
+      - samples/**
 
 jobs:
   build-android:
     name: Build Android
     runs-on: ubuntu-latest
     defaults:
       run:
-        working-directory: showcase
+        working-directory: samples
     steps:
       - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
       - uses: actions/setup-java@v4

.github/workflows/showcase_presubmit.yaml → .github/workflows/samples_presubmit.yaml

@@ -1,12 +1,12 @@
-name: Showcase Presubmit
+name: Samples Presubmit
 
 on:
   workflow_dispatch: {}
   pull_request:
     branches: [ master ]
     paths:
-      - .github/workflows/showcase_presubmit.yaml
-      - showcase/**
+      - .github/workflows/samples_presubmit.yaml
+      - samples/**
 
 jobs:
   prepare:
@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     defaults:
       run:
-        working-directory: showcase
+        working-directory: samples
 
     steps:
       - uses: tibdex/github-app-token@v2

CONTRIBUTING.md

@@ -55,6 +55,4 @@ Lastly, types from 3rd party packages should not be publicly exported by Forui.
 
 ## Conventions
 
-* Bundle assets in `forui_assets`, see https://github.com/flutter/flutter/issues/106782.
-* Make all widgets accessible in the showcase project.
-* Prefix all publicly exported widgets with `Fui`, i.e. `FuiScaffold`.
+* Prefix all publicly exported widgets with `F`, i.e. `FScaffold`.

forui/.flutter-plugins

@@ -0,0 +1,6 @@
+# This is a generated file; do not edit or check into version control.
+path_provider=C:\\Users\\Matthias\\AppData\\Local\\Pub\\Cache\\hosted\\pub.dev\\path_provider-2.1.2\\
+path_provider_android=C:\\Users\\Matthias\\AppData\\Local\\Pub\\Cache\\hosted\\pub.dev\\path_provider_android-2.2.2\\
+path_provider_foundation=C:\\Users\\Matthias\\AppData\\Local\\Pub\\Cache\\hosted\\pub.dev\\path_provider_foundation-2.3.2\\
+path_provider_linux=C:\\Users\\Matthias\\AppData\\Local\\Pub\\Cache\\hosted\\pub.dev\\path_provider_linux-2.2.1\\
+path_provider_windows=C:\\Users\\Matthias\\AppData\\Local\\Pub\\Cache\\hosted\\pub.dev\\path_provider_windows-2.2.1\\

forui/.flutter-plugins-dependencies

@@ -0,0 +1 @@
+{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"path_provider_foundation","path":"C:\\\\Users\\\\Matthias\\\\AppData\\\\Local\\\\Pub\\\\Cache\\\\hosted\\\\pub.dev\\\\path_provider_foundation-2.3.2\\\\","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"android":[{"name":"path_provider_android","path":"C:\\\\Users\\\\Matthias\\\\AppData\\\\Local\\\\Pub\\\\Cache\\\\hosted\\\\pub.dev\\\\path_provider_android-2.2.2\\\\","native_build":true,"dependencies":[]}],"macos":[{"name":"path_provider_foundation","path":"C:\\\\Users\\\\Matthias\\\\AppData\\\\Local\\\\Pub\\\\Cache\\\\hosted\\\\pub.dev\\\\path_provider_foundation-2.3.2\\\\","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"linux":[{"name":"path_provider_linux","path":"C:\\\\Users\\\\Matthias\\\\AppData\\\\Local\\\\Pub\\\\Cache\\\\hosted\\\\pub.dev\\\\path_provider_linux-2.2.1\\\\","native_build":false,"dependencies":[]}],"windows":[{"name":"path_provider_windows","path":"C:\\\\Users\\\\Matthias\\\\AppData\\\\Local\\\\Pub\\\\Cache\\\\hosted\\\\pub.dev\\\\path_provider_windows-2.2.1\\\\","native_build":false,"dependencies":[]}],"web":[]},"dependencyGraph":[{"name":"path_provider","dependencies":["path_provider_android","path_provider_foundation","path_provider_linux","path_provider_windows"]},{"name":"path_provider_android","dependencies":[]},{"name":"path_provider_foundation","dependencies":[]},{"name":"path_provider_linux","dependencies":[]},{"name":"path_provider_windows","dependencies":[]}],"date_created":"2024-03-04 21:30:06.417920","version":"3.19.0"}

forui/assets/fonts/inter/OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2020 The Inter Project Authors (https://github.com/rsms/inter)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

forui/lib/forui.dart

@@ -1 +1,4 @@
 library forui;
+
+export 'src/theme.dart';
+export 'src/theme_data.dart';

forui/lib/src/theme.dart

@@ -0,0 +1,43 @@
+import 'package:flutter/material.dart';
+import 'package:forui/src/theme_data.dart';
+
+class FTheme extends StatefulWidget {
+  static FThemeData of(BuildContext context) {
+    final theme = context.dependOnInheritedWidgetOfExactType<_InheritedTheme>();
+    return theme?.data ?? const FThemeData.light();
+  }
+
+  final FThemeData data;
+  final Widget child;
+
+  const FTheme({
+    super.key,
+    required this.data,
+    required this.child,
+  });
+
+  @override
+  State<StatefulWidget> createState() => _State();
+}
+
+class _State extends State<FTheme> {
+  late FThemeData data;
+
+  @override
+  void initState() {
+    super.initState();
+    data = widget.data;
+  }
+
+  @override
+  Widget build(BuildContext context) => _InheritedTheme(data: data, child: widget.child);
+}
+
+class _InheritedTheme extends InheritedWidget {
+  final FThemeData data;
+
+  const _InheritedTheme({required this.data, required super.child});
+
+  @override
+  bool updateShouldNotify(covariant _InheritedTheme old) => data != old.data;
+}

forui/lib/src/theme_data.dart

@@ -0,0 +1,7 @@
+class FThemeData {
+  const FThemeData();
+
+  const FThemeData.light();
+
+  const FThemeData.dark();
+}

forui/pubspec.yaml

@@ -10,9 +10,8 @@ environment:
 dependencies:
   flutter:
     sdk: flutter
-  # TODO: replace with pub version once forui_assets is published
-  forui_assets:
-    path: ../forui_assets
+  google_fonts: ^6.2.0
+  meta: ^1.11.0
   sugar: ^3.1.0
 
 dev_dependencies:
@@ -26,15 +25,13 @@ dev_dependencies:
       url: https://github.com/forus-labs/cauldron.git
       path: stevia_runner
 
-dependency_overrides:
-  forui_assets:
-    path: ../forui_assets
-
 # 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 packages.
 flutter:
+  assets:
+    - assets/fonts/inter
 
   # To add assets to your package, add an assets section, like this:
   # assets:
@@ -53,16 +50,7 @@ flutter:
   # 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