Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #5

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 58 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,63 @@
# lucide_icons
<p align=center><img width="480" src="https://lucide.dev/lucide-logo-repo.svg" alt="Lucide Logo"></p>
<p align="center">
<a href="https://github.com/lucide-icons/lucide/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/lucide" alt="license"></a>
<a href="https://pub.dev/packages/lucide_icons"><img src="https://img.shields.io/pub/v/lucide_icons.svg" alt="pub package"></a>
<a href="https://pub.dev/packages/lucide_icons/publisher"><img src="https://img.shields.io/pub/publisher/lucide_icons.svg" alt="pub publisher"></a>
<a href="https://github.com/lucide-icons/lucide-flutter/actions/workflows/publish.yaml"><img src="https://github.com/lucide-icons/lucide-flutter/actions/workflows/publish.yaml/badge.svg" alt="publish status"></a>
<a href="https://discord.gg/EH6nSts"><img src="https://img.shields.io/discord/723074157486800936?label=chat&logo=discord&logoColor=%23ffffff&colorB=%237289DA" alt="discord chat"></a>
</p>

> :warning: This package is not in active development anymore. Please use [iconify_flutter](https://pub.dev/packages/iconify_flutter) instead.
# Lucide

Lucide Icons ([lucide.dev](https://lucide.dev)) for Flutter. Visit the website for the full list of icons.
Community-run fork of [Feather Icons](https://github.com/feathericons/feather), open for anyone to contribute icons.

## Getting started

1. Add this package to your dependencies.

```yaml
dependencies:
lucide_icons: latest_version
```

2. Get the dependencies.

```sh
flutter pub get
```

Keep in mind that due to Lucide being below version 1.0.0, all releases are treated like breaking changes by the package manager if you use caret syntax (e.g. `lucide_icons: ^0.257.0`). See the [documentation](https://dart.dev/tools/pub/dependencies#caret-syntax) for more details about caret syntax.

## Usage

You can use this package just like any other icon set.

## Example
```dart
Icon(LucideIcons.activity);
import 'package:flutter/material.dart';
import 'package:lucide_icons/lucide_icons.dart';

class SomeWidget extends StatelessWidget {
const SomeWidget({super.key});

@override
Widget build(BuildContext context) {
return const Icon(
// Pass your icon here.
LucideIcons.accessibility,
size: 100,
color: Colors.red,
);
}
}

```

## Naming

All icons use names from https://lucide.dev/icons converted to camelCase to match Dart's naming conventions.

## Additional information

- This package requires at least Flutter 3.10 (Dart 3.0) to work.
- If there are any issues related to this package and usage with Flutter, go to [GitHub Issues](https://github.com/lucide-icons/lucide-flutter/issues) and report a bug.
- For issues with icons see the [main repository](https://github.com/lucide-icons/lucide/issues).