Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
adityathakurxd authored Jul 25, 2021
1 parent 1191770 commit b4888de
Showing 1 changed file with 59 additions and 12 deletions.
71 changes: 59 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,64 @@
# fancy_containers

Fancy Containers Flutter Package to add a fancy container to your Flutter App.
# Fancy Containers

## Getting Started
Fancy container package lets you add a beautiful gradient container to your Flutter app.

Add the dependency to your Flutter App.
Import the package and use in your Flutter App.
## Installation

This project is a starting point for a Dart
[package](https://flutter.dev/developing-packages/),
a library module containing code that can be shared easily across
multiple Flutter or Dart projects.
1. Add the latest version of package to your pubspec.yaml (and run`dart pub get`):
```yaml
dependencies:
fancy_containers: ^0.0.1
```
2. Import the package and use it in your Flutter App.
```dart
import 'package:fancy_containers/fancy_containers.dart';
```

For help getting started with Flutter, view our
[online documentation](https://flutter.dev/docs), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
## Example
There are a number of properties that you can modify:

- height
- width
- title
- subtitle
- gradient (color1 and color2)

<hr>

<table>
<tr>
<td>

```dart
class FancyScreen extends StatelessWidget {
const FancyScreen({Key? key}) : super(key: key);
@override
Widget build(BuildContext context) {
return Scaffold(
body: Center(
child: const FancyContainer(
title: 'Hello World',
color1: Colors.lightGreenAccent,
color2: Colors.lightBlue,
subtitle: 'This is a new package',
),
),
);
}
}
```

</td>
<td>
<img src="https://user-images.githubusercontent.com/53579386/126896556-911d4778-04cd-49bf-b32a-01a6eb3b0155.jpeg" alt="">
</td>
</tr>
</table>

## Next Goals

- [ ] Add onTap for functions.
- [ ] Change font and color style for text.
- [ ] Add more containers to the package.

0 comments on commit b4888de

Please sign in to comment.