# github-lang-to-icon

@altenull/github-lang-to-icon package version npm weekly downloads github-lang-to-icon is released under the MIT license React Typescript

React component that converts the GitHub language into an icon.

## ⚙️ Installation ```bash $ npm install --save @altenull/github-lang-to-icon ``` ## 🚀 Quick Start ```tsx import { GithubLangToIcon } from '@altenull/github-lang-to-icon'; render() { return ( ); } ``` ### Props | Prop | Type | Default | Description | | :-----: | :--------------------------------: | :-----: | :-------------------------------------------------: | | `lang` | GithubLang \| LowercasedGithubLang | | type LowercasedGithubLang = Lowercase\ | | `size` | number \| undefined | 40 | Icon's width & height | | `style` | React.CSSProperties \| undefined | | | ### Supported Languages - `GithubLang(type)` is based on response of [List repository languages (Github API)](https://docs.github.com/en/rest/repos/repos#list-repository-languages). - The source of below icon images is [devicon](https://github.com/devicons/devicon). - [About repository languages (Github API)](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-repository-languages) | GithubLang(type) | Icon(svg) | | :--------------: | :----------------------------------------------------------------------------------------------------------: | | 'C' | | | 'Clojure' | | | 'CoffeeScript' | | | 'C++' | | | 'C#' | | | 'CSS' | | | 'Dart' | | | 'Elixir' | | | 'Elm' | | | 'Erlang' | | | 'F#' | | | 'Go' | | | 'Groovy' | | | 'Haskell' | | | 'HTML' | | | 'Java' | | | 'JavaScript' | | | 'Julia' | | | 'Kotlin' | | | 'Lua' | | | 'Markdown' | | | 'MATLAB' | | | 'Nix' | | | 'Objective-C' | | | 'OCaml' | | | 'Perl' | | | 'PHP' | | | 'Python' | | | 'R' | | | 'Ruby' | | | 'Rust' | | | 'Scala' | | | 'SCSS' | | | 'Shell' | | | 'Stylus' | | | 'Swift' | | | 'TypeScript' | | | 'Vim Script' | | ## 📝 License Licensed under the [MIT](./LICENSE).