Skip to content

Commit

Permalink
chore: update readme & changelog and bump (#41)
Browse files Browse the repository at this point in the history
  • Loading branch information
bharat-1809 authored May 21, 2024
1 parent f26c5fe commit f180267
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 5 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## 4.0.0

- Make `height` and `width` properties non required in `GlassContainer`
- `GlassContainer` now takes 'boxShadow' as a parameter to customize the shadow instead of `shadowColor` and `elevation`
- Add example to demonstrate the usage of `GlassContainer` in `ListView`

## 3.0.0

- Update minimum supported SDK version to Flutter 3.0/Dart 3.0
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ You should add the following to the `pubspec.yaml` file:

```yaml
dependencies:
glass_kit: ^3.0.0
glass_kit: ^4.0.0
```
You should then run `flutter packages get` in your terminal so as to get the package.<br>
Expand All @@ -61,16 +61,16 @@ import 'package:glass_kit/glass_kit.dart';

# Usage

To create a basic clear glass container you can use the `clearGlass` constructor. Just provide the `height` and `width` and you are good to go. The `clearGlass` and `frostedGlass` constructors assign default values to the properties if not provided.
To create a basic clear glass container you can use the `clearGlass` constructor. If needed, just provide the `height` and `width` and you are good to go. The `clearGlass` and `frostedGlass` constructors assign default values to the properties if not provided.

```dart
GlassContainer.clearGlass(height: 200, width: 300, child: Child());
GlassContainer.clearGlass(child: Child());
```

To create a frosted glass container use the `frostedGlass` constructor.

```dart
GlassContainer.frostedGlass(height: 200, width: 300, child: Child());
GlassContainer.frostedGlass(width: 300, child: Child());
```

Depending on your requirements you can tweak with the properties and create awesome glass widgets. You can also use the `GlassContainer` constructor to create fully customizable glass widgets.<br><br>
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: glass_kit
description: A package containing widgets to implement glass morphism in flutter apps.
version: 3.0.0
version: 4.0.0
homepage: https://github.com/bharat-1809/glass_kit

environment:
Expand Down

0 comments on commit f180267

Please sign in to comment.