file icons js

@exuanbo/arquivo-icons-js

Ícones específicos de arquivo para projeto front-end, extraído de arquivos-icons/átomo

Índice

• Demonstração
• Descrição
• O que está incluído
• Instalação
• Uso
  • CSS
    • Local
    • Com CDN e fontes da web
    • Personalizar
  • JavaScript
    • Node.js
      • 1. Módulo CJS
      • 2. Módulo ES
    • Navegador
      • 1. Módulo navegalizado
      • 2. Módulo ES
  • Referência da API
    • nome
    • opções
      • options.color
      • options.array
    • Exemplo
• Reconhecimento
• PENDÊNCIA
• Licença

Demonstração

https://exuanbo.github.io/file-icons-js/

É também um modelo de partida para usar no navegador

Descrição

• CSS com fontes auto-hospedadas e fontes da web
• JavaScript para obter classes por nome do arquivo com extensão, nome específico do diretório e nome da linguagem de programação

O que está incluído

dist
├── css
│   ├── file-icons-cdn.css
│   ├── file-icons-cdn.min.css
│   ├── file-icons.css
│   └── file-icons.min.css
├── fonts
│   ├── devopicons.woff2
│   ├── file-icons.woff2
│   ├── fontawesome.woff2
│   ├── mfixx.woff2
│   └── octicons.woff2
└── js
    ├── file-icons.esm.js
    ├── file-icons.esm.min.js
    ├── file-icons.js
    └── file-icons.min.js

3 directories, 13 files

Instalação

npm i @exuanbo/file-icons-js

Ou download de lançamentos do GitHub

Uso

Semelhante a font-awesome

 < i class =" icon css3-icon medium-blue " > </ i >

Lista completa de classes disponíveis pode ser encontrada em

• styles/icons.less
• styles/colors.less

Referência do ícone

• Icons de arquivos
• Fontawesome 4.7.0
• Mfizz
• Devicons

CSS

dist/css
├── file-icons-cdn.css
├── file-icons-cdn.min.css
├── file-icons.css
└── file-icons.min.css

Adicione uma tag de link para a cabeça ou @import

Local

dist/css/file-icons.min.css

 < link href =" node_modules/@exuanbo/file-icons-js/dist/css/file-icons.min.css " rel =" stylesheet " > 

Com CDN e fontes da web

dist/css/file-icons-cdn.min.css

 < link href =" node_modules/@exuanbo/file-icons-js/dist/css/file-icons-cdn.min.css " rel =" stylesheet " >

em que url é remoto,

 @font-face {
  font-family : "file-icons" ;
  font-weight : normal;
  font-style : normal;
  src : url ( "https://cdn.jsdelivr.net/npm/@exuanbo/file-icons-js@latest/fonts/file-icons.woff2" ) format ( "woff2" );
}

Ou usando inteiramente CDN,

 < link href =" https://cdn.jsdelivr.net/npm/@exuanbo/file-icons-js@latest/dist/css/file-icons.min.css " rel =" stylesheet " > 

Personalizar

Por padrão,

. icon : before {
  font-weight : normal;
  font-style : normal;
  text-align : center;
  width : 16 px ;
  line-height : 1 ;
  position : relative;
  display : inline-block;
  -webkit-font-smoothing : antialiased;
}

JavaScript

dist/js
├── file-icons.esm.js
├── file-icons.esm.min.js
├── file-icons.js
└── file-icons.min.js

 // package.json
{
  "main" : " ./dist/js/file-icons.js " ,
  "module" : " ./dist/js/file-icons.esm.js " ,
  "browser" : " ./dist/js/file-icons.min.js "
}

 // dist/js/file-icons.esm.js
var main = new FileIcons ( ) ;
export default main ; 

Node.js

1. Módulo CJS

 const icons = require ( '@exuanbo/file-icons-js' ) 

2. Módulo ES

 import icons from '@exuanbo/file-icons-js' 

Navegador

1. Módulo navegalizado

dist/js/file-icons.min.js

 <!-- Locally -->
< script src =" node_modules/@exuanbo/file-icons-js/dist/js/file-icons.min.js " > </ script >

<!-- With CDN -->
< script src =" https://cdn.jsdelivr.net/npm/@exuanbo/file-icons-js@latest/dist/js/file-icons.min.js " > </ script >

Em seguida, crie uma instância,

 < script >
  const icons = require ( 'file-icons-js' )
</ script > 

2. Módulo ES

dist/js/file-icons.esm.min.js

 <!-- Locally -->
< script type =" module " >
  import icons from 'node_modules/@exuanbo/file-icons-js/dist/js/file-icons.esm.min.js'
</ script >

<!-- With CDN -->
< script type =" module " >
  import icons from 'https://cdn.jsdelivr.net/npm/@exuanbo/file-icons-js@latest/dist/js/file-icons.esm.min.js'
</ script >

Referência da API

getClass(name, options?)

Retornar Promise<string|string[]>

Nota : Este método é promissor baseado desde a versão 3 e compatível com assíncrono/aguardar

nome

Tipo: String

Aceite o nome do arquivo com extensão como 'index.js' , nome específico do diretório como 'node_modules' ou '.github' , nome da linguagem de programação como 'Javascript'

A string terminada com / será considerada como diretório, por exemplo '.emacs.d/'

opções

Tipo: Object

options.color

Tipo: boolean
Padrão: true

As aulas retornadas contêm cor 'icon js-icon medium-yellow'

options.array

Tipo: boolean
Padrão: false

Retorne uma matriz de string ['icon', 'js-icon', 'medium-yellow']

Exemplo

 icons . getClass ( 'package.json' )
// -> Promise {<resolved>: "icon npm-icon medium-red"}

icons . getClass ( 'Javascript' )
// -> Promise {<resolved>: "icon js-icon medium-yellow"}

icons . getClass ( 'node_modules' , {
  array : true
} )
// -> Promise {<resolved>: ['icon', 'node-icon', 'medium-green']}

icons . getClass ( 'node_modules' , {
  color : false ,
  array : true
} )
// -> Promise {<resolved>: ['icon', 'node-icon']} 

Reconhecimento

• icons de arquivo/átomo

PENDÊNCIA

• Suporte de CDN
• site de demonstração
• versão webfont do CSS
• Módulo ES

Licença

Mit

Doar