Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
afshinpir committed Mar 19, 2019
2 parents 37065c6 + b01797d commit 2ab143e
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# NavigationView

This Android library is designed for adding fixed and scrollable header
and footer support to Android's default NavigationView.
and footer support to Android's [NavigationView][1].

## Usage

Expand Down Expand Up @@ -33,13 +33,12 @@ dependencies {
}
```

**Note**: NavigationView uses
[Android X](https://developer.android.com/jetpack/androidx/) artifacts.
So you need to migrate to it before using this library.
**Note**: This library uses
[Android X](https://developer.android.com/jetpack/androidx/) artifacts. Thus, you need to migrate to it before using this library.

### Code

In order to use this NavigationView, it is enough to change your widget
In order to use this library, it is enough to change your widget
from:

`android.support.design.widget.NavigationView`
Expand Down Expand Up @@ -67,6 +66,10 @@ all types of headers and footers, you can create layouts like this one:

![](./blob/all-sections.gif "All fixed and scrollable headers and footers")

Other attributes of NavigationView are also supported.
---
This widget is created based on Android's default NavigationView.
Other attributes of NavigationView are also supported.

### Note

Since widget is created based on Android's [NavigationView][1], I was constrainted to its limitations. I may try to improve library adding new features later.

[1]: https://developer.android.com/reference/android/support/design/widget/NavigationView

0 comments on commit 2ab143e

Please sign in to comment.