-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
changes other guides for docs folder
- Loading branch information
1 parent
2e2f060
commit 4eea227
Showing
3 changed files
with
79 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
#### Tree-Shaking | ||
|
||
O tree-shaking é uma das partes mais complicadas ao se trabalhar com biblioteca de componentes. | ||
|
||
Basicamente o tree-shaking é uma técnica de otimização de código que elimina o código morto (código que não é utilizado) | ||
do seu bundle final. | ||
|
||
Para garantir o tree-shaking é necessário que seu código esteja no esm, que sua funções não tenha side effects ou utilizar a anotação do bundle `/* @__PURE__ */`, para | ||
isso utilizamos duas ferramentas para auxiliar: | ||
|
||
- A primeira é o eslint-plugin-tree-shaking | ||
- A segunda ferramenta é o Plugin rollup-plugin-pure que anota algumas funções como PURAS; | ||
- A terceira é o agadoo que verifica se seu código está otimizado para o tree-shaking (Essa ferramenta não confio muito | ||
sinceramente, creio que ela tenha falso positivo) | ||
- Para rodar basta: `yarn build && yarn agadoo` | ||
- O output será o código que não está otimizado para o tree-shakable | ||
|
||
Como verificar se meu componente está Tree-Shakable? | ||
|
||
- No index.js os componentes que atualmente não estão tree-shakable segundo o agadoo estão comentados | ||
- Comente todos os componentes com TODO | ||
- Rode o agadoo vai retornar sucesso | ||
- Descomente um dos componentes e rode o agadoo novamente | ||
- Se der erro, o componente não está otimizado para o tree-shaking | ||
|
||
Problemas atuais | ||
|
||
- Atualmente os componentes que utilizam a headlessui ou então o react-mask-input não são tree-shakable | ||
|
||
Fontes: | ||
|
||
- https://github.com/vitejs/vite/issues/5174 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
## Mudanças da V0.4 para a V1.0 | ||
|
||
## Breaking Changes | ||
|
||
- Mudança de posicionamento do `Tooltip` e `Popover`: Atualmente o Tooltip não ocupa a melhor posição possível pelo fato | ||
de estarmos utilizando uma biblioteca nova, o popover também possui o uso da mesma biblioteca porém ainda | ||
é possível se passar o position para o popover. | ||
- O comportamento do componente `Tab` foi alterado onde agora para se utilizar o usuário deve passar as tabs como | ||
children | ||
e não mais utilizando o array de tabs. | ||
- Os componentes `SearchInput` & `SelectBox` foram depreciados (Serão removidos em versões futuras) para adição dos | ||
novos componentes Select & SelectAsync. | ||
|
||
## Changelog | ||
|
||
### Correções | ||
|
||
- Correção do tamanho do item da Sidebar | ||
- correção na propriedade disabled do componente SelectBox | ||
- Correção das cores de selecionado dos componentes do SelextBox | ||
- Correção das cores de cinza dos componentes de SelectBox, SearchInput e TextField | ||
- Correção do Z-index dos componentes tooltip e popover | ||
- Correção em todas as cores da biblioteca | ||
|
||
### Melhorias | ||
|
||
- Adição de sombra para o componente do SelectBox | ||
- Melhora da DX do vite com auto complete | ||
- Upgrade nas dependências da biblioteca | ||
- Melhora na responsividade do componente Text | ||
- Padronização das props para os componentes de Forms. | ||
- Melhora no comportamento do componente Sidebar, ao clicar no DropdownItem ela abre. | ||
- Melhorias nas documentações da biblioteca | ||
- Componentes Tooltip e Popover com um comportamento melhor, não necessário mais setar o position. | ||
- Remoção dos warnings da biblioteca. | ||
|
||
### Novas funcionalidades | ||
|
||
- Criação do componente de Paginação. | ||
- Criação do componente de Modal. | ||
- Criação do novo componente de Tabs. | ||
- Criação de um novo componente SelectBox | ||
- Adição do Tree Shaking para a biblioteca com o intúito de melhorar o bundle para o usuário. | ||
- Adição da props Loading para o botão. |