-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
176 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,8 @@ | ||
coverage/**/*.html linguist-vendored | ||
coverage/**/*.css linguist-vendored | ||
example/**/*.cpp linguist-vendored | ||
example/**/*.cc linguist-vendored | ||
example/**/*.h linguist-vendored | ||
example/**/*.cmake linguist-vendored | ||
example/**/*.txt linguist-vendored | ||
example/**/*.swift linguist-vendored | ||
*.sh linguist-vendored | ||
example/**/*.html linguist-vendored | ||
example/**/*.kt linguist-vendored |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# These are supported funding model platforms | ||
|
||
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] | ||
patreon: # Replace with a single Patreon username | ||
open_collective: # Replace with a single Open Collective username | ||
ko_fi: nialixus | ||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel | ||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry | ||
liberapay: # Replace with a single Liberapay username | ||
issuehunt: # Replace with a single IssueHunt username | ||
otechie: # Replace with a single Otechie username | ||
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry | ||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: bug | ||
assignees: Nialixus | ||
|
||
--- | ||
|
||
### Describe the bug | ||
A clear and concise description of what the bug is. | ||
|
||
### To Reproduce | ||
Steps to reproduce the behavior: | ||
1. **Setup:** | ||
- Flutter version: [e.g., 2.5.3] | ||
- Dart version: [e.g., 2.14.4] | ||
- Device/Emulator: [e.g., iPhone 12, Pixel 4, etc.] | ||
- Operating System: [e.g., iOS 14.5, Android 11] | ||
2. **Steps:** | ||
- Go to '...' | ||
- Click on '....' | ||
- Scroll down to '....' | ||
- See error | ||
|
||
### Expected behavior | ||
A clear and concise description of what you expected to happen. | ||
|
||
### Screenshots/Video | ||
Add screenshots or a video to help explain your problem. | ||
|
||
### Flutter Doctor Output | ||
Please paste the output of `flutter doctor -v` here. | ||
|
||
### Context | ||
Add any other context about the problem here, including the full code for the activity/page where the issue occurs. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: enhancement | ||
assignees: Nialixus | ||
|
||
--- | ||
|
||
### Is your feature request related to a problem? Please describe. | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
### 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. | ||
|
||
### Flutter Doctor Output | ||
Please paste the output of `flutter doctor -v` here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
name: Test Coverage | ||
|
||
on: | ||
push: | ||
branches: [master] | ||
pull_request: | ||
branches: [master] | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v2 | ||
|
||
- name: Set up Flutter | ||
uses: subosito/flutter-action@v2 | ||
with: | ||
flutter-version: "3.10.6" | ||
|
||
- name: Install dependencies | ||
run: flutter pub get | ||
|
||
- name: Run tests with coverage | ||
run: flutter test --coverage | ||
|
||
- name: Upload coverage reports to Codecov | ||
uses: codecov/[email protected] | ||
with: | ||
token: ${{ secrets.CODECOV_TOKEN }} | ||
|
||
- name: Display coverage report link | ||
run: | | ||
echo "Coverage report uploaded to Codecov. View the report at: https://codecov.io/gh/Nialixus/thicken" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,2 @@ | ||
## 0.0.1 | ||
|
||
* TODO: Describe initial release. | ||
## 1.0.0 | ||
* Initial Release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,21 @@ | ||
TODO: Add your license here. | ||
MIT License | ||
|
||
Copyright (c) 2024 Louis Wiwawan | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
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 | ||
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 | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,59 @@ | ||
<!-- | ||
This README describes the package. If you publish this package to pub.dev, | ||
this README's contents appear on the landing page for your package. | ||
<p align="center"> | ||
<img src="https://github.com/Nialixus/thicken/blob/38cfe510ce50ec40b4dd2ed7fada365bf16f89d0/logo.png" alt="Thicken Logo" width="150"> | ||
</p> | ||
|
||
For information about how to write a good package README, see the guide for | ||
[writing package pages](https://dart.dev/guides/libraries/writing-package-pages). | ||
# Type Writer Text | ||
|
||
For general information about developing packages, see the Dart guide for | ||
[creating packages](https://dart.dev/guides/libraries/create-library-packages) | ||
and the Flutter guide for | ||
[developing packages and plugins](https://flutter.dev/developing-packages). | ||
--> | ||
<a href='https://pub.dev/packages/thicken'><img src='https://img.shields.io/pub/v/thicken.svg?logo=flutter&color=blue&style=flat-square'/></a> | ||
<a href="https://codecov.io/gh/Nialixus/thicken"><img src="https://codecov.io/gh/Nialixus/thicken/graph/badge.svg?token=T66X1R33QE"/></a> | ||
<a href="https://github.com/Nialixus/thicken/actions"><img src="https://github.com/Nialixus/thicken/actions/workflows/test_coverage.yaml/badge.svg" alt="test"/></a> | ||
\ | ||
\ | ||
A widget that creates a thick visual effect by stacking multiple layers of a given `child` widget with slight translations based on the `thickness` value. | ||
|
||
TODO: Put a short description of the package here that helps potential users | ||
know whether this package might be useful for them. | ||
## Preview | ||
|
||
## Features | ||
<img src="https://github.com/user-attachments/assets/451d0265-dd2d-4134-807d-a02e1f17b8bb" alt="TypeWriterText Preview" width="300"> | ||
|
||
TODO: List what your package can do. Maybe include images, gifs, or videos. | ||
|
||
## Getting started | ||
## Install | ||
|
||
TODO: List prerequisites and provide or point to information on how to | ||
start using the package. | ||
Add this line to your pubspec.yaml. | ||
|
||
```yaml | ||
dependencies: | ||
thicken: ^1.0.0 | ||
``` | ||
## Usage | ||
TODO: Include short and useful examples for package users. Add longer examples | ||
to `/example` folder. | ||
First, import the typewriter package. | ||
```dart | ||
const like = 'sample'; | ||
import 'package:thicken/thicken.dart'; | ||
``` | ||
|
||
## Additional information | ||
And use it like this | ||
|
||
```dart | ||
Thicken( | ||
thickness: 0.15, | ||
child: Icon( | ||
Icons.star, | ||
size: 50.0, | ||
), | ||
); | ||
``` | ||
|
||
## Documentation | ||
|
||
### TypeWriter.text | ||
|
||
| Property | Purpose | | ||
| ------------------ | ----------------------------------------------------------------------------------------------------------------- | | ||
| thickness | The amount of thickness applied. _**(It is not recommended to set thickness greater than 1.0)**_ | | ||
| child | The child widget that will be thickened as multiple layers. | | ||
|
||
## Example | ||
|
||
TODO: Tell users more about the package: where to find more information, how to | ||
contribute to the package, how to file issues, what response they can expect | ||
from the package authors, and more. | ||
- <a href="https://github.com/Nialixus/thicken/blob/master/example/lib/main.dart">thicken/example/lib/main.dart</a> |