Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keshav-space/safenotes-nord-theme
https://github.com/keshav-space/safenotes-nord-theme
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/keshav-space/safenotes-nord-theme
- Owner: keshav-space
- License: other
- Created: 2024-03-24T12:05:57.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-03-24T14:05:51.000Z (9 months ago)
- Last Synced: 2024-10-28T05:00:00.573Z (about 2 months ago)
- Language: Dart
- Homepage:
- Size: 336 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# safenotes_nord_theme
An arctic, north-bluish theme for Flutter, based on the
[Nord theme](https://www.nordtheme.com/).
**Warning**: This is not an official theme (not made by Arctic Ice Studio).
> [!NOTE]
> This is a maintained fork of https://github.com/Firefnix/flutter-nord-theme used by the `safenotes` project https://github.com/keshav-space/safenotes.
## Installing
First, add this package to your Flutter project (see also Installation).
In your `pubspec.yaml`, add `safenotes_nord_theme` as a dependency:
```yaml
safenotes_nord_theme:
git:
url: https://github.com/keshav-space/safenotes-nord-theme.git
ref: main
```
## How to use
#### NordTheme
Once the package is installed, you can pass either `NordTheme.dark` or
`NordTheme.light` as a `ThemeData` to your app.
```dart
class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
return MaterialApp(
themeMode: ThemeMode.light, // or [ThemeMode.dark]
theme: NordTheme.light(),
darkTheme: NordTheme.dark(),
home: Scaffold(
appBar: AppBar(title: Text('Title')),
body: Center(child: Text('Example text.')),
),
);
}
}
```
#### NordColors
Apart from `NordTheme`, this package comes with a second class: `NordColors`, that provides various ways to access the 16 colors of the Nord palette (numbered from 0 to 16 as in the [docs](https://www.nordtheme.com/docs/colors-and-palettes)):
```dart
NordColors.$0; // a dart [Color], the same ones Flutter uses
NordColors.$13.withAlpha(0.5); // comes by default with a full opacity
```
In the official Nord documentation, the colors are not named, they are only numbered. For this package we decided to provide in addition to an access by their number a way to access the colors by names. For the correspondence, see the table below. Here is an example:
```dart
NordColors.frost.darker;
NordColors.aurora.green;
```
| Number | Name |
|--------|---------------------|
| 0 | polarNight.darkest |
| 1 | polarNight.darker |
| 2 | polarNight.lighter |
| 3 | polarNight.lightest |
| 4 | snowStorm.darkest |
| 5 | snowStorm.medium |
| 6 | snowStorm.lightest |
| 7 | frost.lightest |
| 8 | frost.lighter |
| 9 | frost.darker |
| 10 | frost.darkest |
| 11 | aurora.red |
| 12 | aurora.orange |
| 13 | aurora.yellow |
| 14 | aurora.green |
| 15 | aurora.purple |
## License
This package is licensed under the [MIT License](https://mit-license.org/).