https://github.com/davqq/mahappsiconpackpreview

Simplify your workflow with real-time icon visualization.
https://github.com/davqq/mahappsiconpackpreview

csharp extension icons mahapps material-ui visual-studio workflow wpf

Last synced: 27 days ago
JSON representation

Simplify your workflow with real-time icon visualization.

• Host: GitHub
• URL: https://github.com/davqq/mahappsiconpackpreview
• Owner: davqq
• License: mit
• Created: 2024-08-04T15:14:36.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-09-14T11:13:59.000Z (about 2 months ago)
• Last Synced: 2024-10-10T14:04:54.641Z (27 days ago)
• Topics: csharp, extension, icons, mahapps, material-ui, visual-studio, workflow, wpf
• Language: C#
• Homepage: https://marketplace.visualstudio.com/items?itemName=davq.MahAppsIconPackPreview
• Size: 24 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MahApps.IconPack Preview Extension

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

[![Platform](https://img.shields.io/badge/platform-.NET-blue.svg)](https://dotnet.microsoft.com/)

[![NuGet](https://img.shields.io/nuget/v/MahApps.Metro.IconPacks.svg)](https://www.nuget.org/packages/MahApps.Metro.IconPacks)

## Overview

The **MahApps.IconPack Preview Extension** is a Visual Studio Code extension that provides an instant preview of icons from the [MahApps.Metro.IconPacks](https://github.com/MahApps/MahApps.Metro.IconPacks) directly in your code. This extension is designed to streamline the development process by offering a visual representation of icons right within your development environment.

## Features

- **Real-time Icon Preview**: Displays a preview of the icons as you work in the code.

- **Support for all MahApps.IconPacks**: Compatible with all icon packs available in MahApps.Metro.IconPacks.

- **Easy Integration**: Simply add the extension to your Visual Studio Code to start seeing previews instantly.

## Installation

To install the MahApps.IconPack Preview Extension, follow these steps:

1. Open Visual Studio Code.

2. Go to the Extensions view (`Ctrl+Shift+X`).

3. Search for `MahApps.IconPack Preview`.

4. Click `Install` to add the extension to your editor.

   Alternatively, you can install the extension directly from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=davq.MahAppsIconPackPreview).

## Usage

1. After installing the extension, open any `.cs` or `.xaml` file that uses MahApps.Metro.IconPacks.

2. When you enter an icon key (e.g., `PackIconModernKind.Settings`, `Kind=Settings`) in your code, a preview of the corresponding icon will appear.

3. Hover over the icon, and a tooltip will appear displaying the icon in a larger size.

## ⚠️Warning⚠️

Ensure that the version of the MahApps.IconPack Preview Extension matches the version of the installed NuGet package for MahApps.Metro.IconPacks in your project. Using mismatched versions might result in incorrect or missing icon previews.

## Examples

Here are some examples of how the preview might appear in your code:

![image](https://github.com/user-attachments/assets/a1fc4e69-d738-4ba0-8b0c-825b5f5c9ec2)

![image](https://github.com/user-attachments/assets/eaeeb437-4384-458f-bf04-91af2a93758b)

When you hover over the icon, the corresponding icon will be displayed.

## Support & Feedback

If you encounter any issues or have feedback about the extension, please open an Issue in the repository. We value your contributions and look forward to improving the extension together.

## License

This project is licensed under the [MIT License](LICENSE).

## Acknowledgements

This extension was inspired by the excellent work on [MahApps.Metro.IconPacks](https://github.com/MahApps/MahApps.Metro.IconPacks). Many thanks to the original developers!