@dreamcommerce/aurora 2.27.1 → 3.0.0-2

package/README.md

@@ -16,22 +16,15 @@ To uaktualni nam wersję np z `0.2.10-1` do `0.2.10-2` i znowu
 
 ## Testowanie:
 
-Posiadamy cztery rodzaje testów, standardowe unit testy, testy strukturalne (snapshoty),wizualne oraz wizualne na dla
-zbudowanej paczki(smoke-test). Jak je odpalić:
+Posiadamy dwa rodzaje testów, standardowe unit testy oraz wizualne. Jak je odpalić:
 
 1. `yarn run tests:unit`
-2. `yarn run tests:structural`
-3. `yarn run tests:visual`
-4. `yarn run tests:smoke-package`
+2. `yarn run tests:visual`
 
-Testy strukturalne i wizualne wykonują się zdecydowanie dłużej niż unit, dlatego nie polecam odpalania ich z każdą
-zmianą. Ponadto testy strukturalne i wizualne opierają się na plikach wzorcowych (generowane przy pierwszym odpaleniu)
-dlatego też jeśli nakodzicie coś w komponencie po odpaleniu testów dostaniecie "errory", które pokażą wam w jakich
-miejscach się przez wasz kod pozmieniało. Trzeba to przeglądnać i jeśli wszystko jest ok "zaakceptować" nowe pliki
-wzoroce. Są od tego dwa polecenia:
+Co gdy celowo zmieniamy wyglad komponentu i testy wizualne nie przechodza? 
+Wtedy musimy zaktualizować pliki wzorcowe:
 
-1. `yarn run updates-snapshots` aktualizuje pliki wzorcowe snapshotow
-2. `yarn run update-visuals` aktualizuje pliki wzorcowe zmian wizualnych (.png)
+1. `yarn run update-visuals` aktualizuje pliki wzorcowe zmian wizualnych (.png)
 
 ## Jak piszemy componenty
 
@@ -42,10 +35,15 @@ wzoroce. Są od tego dwa polecenia:
 3. Typowanie
 4. Rzeczy wewnętrzne komponentu
 
-### Struktura folderów i plików komponentu
+### Komponenty
+
+- do wiekszosci komponentów, korzystamy z opensourcowej libki https://ui.shadcn.com. Kod komponentóœ kopiujemy manualnie i dostosowujemy do naszych potrzeb.
+
+#### Struktura folderów i plików komponentu
 
 - Komponent umieszczamy w folderze `src/components`
 - W nazewnictwie plików i folderów stosujemy `snake_case`
+- Nazwy prefixujemy nazwa komponentu
 - Nazwa komponentu powinna być w liczbe pojedyńczej (button, color_picker, heading itp);
 - struktura komponentu:
 
@@ -53,32 +51,85 @@ wzoroce. Są od tego dwa polecenia:
     - components (komponenty wchodza w sklad glownego komponetu, nieuzywalne osobno)
         - somethings.tsx
         - ...
-    - hoc (komponenty wyzszego rzedu utworzone za pomoca komponentu bazowego)
-        - select
-            - index.tsx
-        - ...
     - hooks (folder zawierajacy hooki specyficzne dla danego elementu)
-        - useValues.ts
+        - [nazwa-komponentu]_useValues.ts
         - ...
-    - css_classes.ts (opcjonalnie, klasy dla danego komponentu)
-    - constants.ts (opcjonalnie, stałe dla tego komponentu)
-    - context.tsx (opcjonalne, context elementu)
-    - index.tsx
-    - types.ts
-    - utilities.ts (opcjonalnie, helpery, funkcje danego komponetu)
+    - [nazwa-komponentu]_constants.ts (opcjonalnie, stałe dla tego komponentu)
+    - [nazwa-komponentu]_context.tsx (opcjonalne, context elementu)
+    - [nazwa-komponentu].tsx
+    - [nazwa-komponentu]_types.ts
+    - [nazwa-komponentu]_utils.ts (opcjonalnie, helpery, funkcje danego komponetu)
 ```
 
-- style komponentu powinny znaleźć się w `src/css/{nazwa_komponentu}` (np src/css/button)
-- struktura styli:
+#### Style
 
-```
-    - main.module.less
-    - mixins.module.less (mixiny danego komponentu)
-    - variables.module.less (zmienne danego komponetu)
-    - responsive.less.module.less (style dla media queries)
-```
+**Autocomplete dla funkcji cva i cx**
+https://cva.style/docs/getting-started/installation#tailwind-css
+
+- do stylowania używamy tailwindcss
+- dostpene tokeny dla różnych wartosci stili (np. `colors`, `spacing`, `fontSizes` itp) znajdują się w pliku `tailwind.config.js`
 
-### Uwagi ogólne
+## Uwagi ogólne
 
 Nazwy metod, zmiennych powinny odpowiadać temu co kryje się za daną zmienną lub co robi metoda. Metody powinny
 realizowac jedna rzeczy. Zmienne typu boolean powinny zawsze zaczynac sie od `is` lub `has`.
+
+## Tymczasowe na czas developmentu westa
+
+- jako, ze wyczysciłam folder z komponentami bo gryzły sie lessy. Niektóre komponenty bd kopiować w zależnosci od kejsu. Np takie taby albo skin-tree bd raczej kopiowane z aurory na tagu 2.0. Nie chcemy zmieniać api tych komponentó
+- czesc bardziej skomplikowanych komponentów bd najprawdopodbniej z osobnych libek, np. select
+
+### Nowa struktura pod storybooka
+
+1. **Feedback and indicators**
+   1. Loader
+   2. Message-box(infobox)
+   3. badge
+   4. flash-messanger
+2. **Table**
+   1. table
+3. **Text**
+   1. Typography
+4. **Selection and Input**
+   1. Checkbox
+   2. Checkbox-switch
+   3. Color-picker
+   4. Date-picker
+   5. File-Picker
+   6. Input
+   7. Select
+   8. MultiSelect
+   9. Radio
+   10. Radio-group
+   11. Textarea
+   12. xhrImagePicker
+   13. Values Syncer
+   14. Hint - ma zostac tyko jeden, juz nie bd tooltip i hint osobno
+   15. Button
+5. **Layout**
+   1. Grid
+   2. Stack
+   3. Box
+   4. Divider 
+   5. Spacing
+6. **Modal**
+7. **Navigation**
+   1. Link
+   2. BreadCrumbs
+   3. Pagination
+   4. Tabs
+   5. Slide
+8. **Lists**
+   1. Search List
+   2. Tree
+   3. Action List
+9. **Surface**
+   1. Accordion
+   2. Dropdown
+   3. Paper - box + shadow
+10. **Utils**
+    1. Scroll Syncer
+    2. Accordion groups
+    3. With Loader
+11. **Hooks**
+    1. ...

package/build/cjs/_virtual/_commonjsHelpers.js

@@ -2,13 +2,10 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
-
 function createCommonjsModule(fn) {
   var module = { exports: {} };
 	return fn(module, module.exports), module.exports;
 }
 
-exports.commonjsGlobal = commonjsGlobal;
 exports.createCommonjsModule = createCommonjsModule;
 //# sourceMappingURL=_commonjsHelpers.js.map

package/build/cjs/_virtual/_commonjsHelpers.js.map

@@ -1 +1 @@
-{"version":3,"file":null,"sources":[null],"sourcesContent":[null],"names":[],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;"}
+{"version":3,"file":null,"sources":[null],"sourcesContent":[null],"names":[],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;"}