Skip to content

📈Lightweight k-line chart that can be highly customized. Zero dependencies. Support mobile.(可高度自定义的轻量级k线图,无第三方依赖,支持移动端)

Notifications You must be signed in to change notification settings

diminha55/KLineChartfork

 
 

Repository files navigation

KLineChart

Português | English

💹📈 Gráfico financeiro leve construído com HTML5 canvas.

GitHub Workflow Status (with branch) Version Size npms.io (maintenance) Typescript LICENSE Docs

✨ Funcionalidades

  • 📦 Pronto para usar: integração simples e rápida.
  • 🚀 Leve e fluido: sem dependências, apenas 40k com gzip.
  • 💪 Poderoso: diversos indicadores e modelos de desenho inclusos.
  • 🎨 Altamente extensível: muitas opções de estilo e API para expandir como desejar.
  • 📱 Mobile: suporte a dispositivos móveis.
  • 🔧 Layout responsivo aprimorado para dispositivos móveis.
  • 🛡 Desenvolvimento em Typescript: inclui definições completas de tipo.
  • 🌗 Pré-visualização com tema claro aprimorado: apenas botões de tema (com ícones) para alternar entre claro e escuro.
  • 🆎 Novo gráfico de pré-visualização: permite mudar o tipo de candle.
  • 📋 Roadmap com metas focadas em aprimorar UI e UX.
  • 🗺️ Roadmap IA modernizado com timeline interativa e animações.
  • 📝 Comentários do código revisados e traduzidos para Português.

📦 Instalação

Usando npm

npm install klinecharts --save

Usando yarn

yarn add klinecharts

📄 Documentação

Online

https://klinechartfork.netlify.app - a documentação é gerada pelo Netlify usando Node 20 e pnpm.

  • As APIs do gráfico e da instância agora possuem páginas em Português em /pt-BR/api.
  • Parte da documentação da API da instância foi traduzida para Português.
  • A seção de FAQ da página inicial também está disponível em Português.

Inicie o serviço de documentação

npm run docs:dev

Após iniciar, abra http://localhost:8888 no navegador.

Para gerar o site estático da documentação (e o bundle usado por ela):
```bash
npm run docs:build

O site gerado será colocado no diretório website.

🛠

Execute no diretório raiz. É necessário Node.js.

# Instale as dependências
npm install

# Gere os arquivos
npm run build

Os arquivos gerados estarão em dist.

🌳 Estrutura do projeto

O diretório src contém todo o núcleo do KLineChart:

  • Chart.ts controla panes, eventos e o ChartStore.
  • Event.ts unifica o tratamento de eventos de usuário.
  • Options.ts define tipos de configuração e formatações.
  • Store.ts armazena dados e estado interno.
  • common/ reúne utilidades compartilhadas.
  • component/ possui eixos, figuras, indicadores e overlays básicos.
  • extension/ abriga módulos registráveis como indicadores e estilos.
  • pane/ define as janelas do gráfico.
  • view/ contém as camadas de desenho.
  • widget/ gerencia canvases e monta as Views.

Para uma descrição detalhada, consulte Estrutura do Código.

🔗 Links

About

📈Lightweight k-line chart that can be highly customized. Zero dependencies. Support mobile.(可高度自定义的轻量级k线图,无第三方依赖,支持移动端)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 76.0%
  • JavaScript 16.2%
  • HTML 7.7%
  • Other 0.1%