React - raczej o konwencjach

React - raczej o konwencjach
DO
  • Rejestracja:prawie 7 lat
  • Ostatnio:około rok
  • Postów:165
1

Cześć,
Mam zagwozdkę natury raczej formalnej. W apce tworzę dużą liczbę komponentów React, przy czym niektóre z nich są bardzo 'małe'. Tak, w tym momencie brakuje mi dobrego słowa, na objęcie komponentów renderujących powiedzmy jednego mały nagłówek, ewentualnie nierenderujących samodzielnie treści (a tylko po ujęciu w innym komponencie) który sposób wyświetlania treści modyfikuje. Z drugiej strony są to podstawowe cegiełki wykorzystywane przez duże komponenty. Granica czasami jest intuicyjna i nieostra, fakt. Natomiast pytanie brzmi czy takie maleństwa powinny być zasadniczo zgrupowane:

w osobnym folderze o nazwie dajmy na to details
w osobnym pliku o nazwie np. details
w jakikolwiek inny sposób zebrane i pogrupowane

oraz, czy wskazane jest nadawanie im jakichś 'znaczących' nazw SpinnerDetail.

Szukałam sugestii tutaj:
https://github.com/airbnb/javascript/tree/master/react#naming

Ale nic tam takiego nie ma

Ewentualnie, jeżeli nie ma konwencji, jakie podejście polecacie?
I jeszcze jedno. Mamy Reduxa, tworzymy coś przez Connect

Kopiuj
const TableBody = connect(mapStateToProps, null)(_TableBody)

O ile literał TableBody jest chyba OK to czy _TableBody dla nazwania funkcji niepołączonej też jest OK?

neves
  • Rejestracja:prawie 22 lata
  • Ostatnio:około 21 godzin
  • Lokalizacja:Kraków
  • Postów:1114
5

Osobiście preferuje podział na komponenty:

  • generczne reużywalne pomiędzy różnymi niezależnymi komponentami, trzymane w w /src/components/nazwa_komponentu/
  • specyficzne dla konkretnej strony, trzymane w /src/pages/nazwa_strony/nazwa komponentu/

jeśli danych komponent jest używany tylko w kontekście innego komponentu to kolejny podfolder dla niego tworze.
I każdy komponent ma zwykle swój folder, bo oprócz tego zwykle dochodzą powiązane z nim dwa pliki: plik testów, i plik storybooka, a często też oddzielny plik styli dla komponentu czy chociażby jeszcze reducer.

Storybook obowiązkowo dla wszystkich komponentów generycznych, i korzeni komponentów specyficznych, podkomponenty mogą mieć storybooka ale nie muszą.

screenshot-20200729120901.png

I jak najbardziej wszystko musi mieć znaczące nazwy, jeśli nie jesteś w stanie wymyślić znaczącej nazwy może to oznaczać że albo komponent robi za dużo albo za mało.


edytowany 5x, ostatnio: neves
DO
  • Rejestracja:prawie 7 lat
  • Ostatnio:około rok
  • Postów:165
0
neves napisał(a):

Osobiście preferuje podział na komponenty:

  • generczne reużywalne pomiędzy różnymi niezależnymi komponentami, trzymane w w /src/components/nazwa_komponentu/
  • specyficzne dla konkretnej strony, trzymane w /src/pages/nazwa_strony/nazwa komponentu/

jeśli danych komponent jest używany tylko w kontekście innego komponentu to kolejny podfolder dla niego tworze.
I każdy komponent ma zwykle swój folder, bo oprócz tego zwykle dochodzą powiązane z nim dwa pliki: plik testów, i plik storybooka, a często też oddzielny plik styli dla komponentu czy chociażby jeszcze reducer.

Storybook obowiązkowo dla wszystkich komponentów generycznych, i korzeni komponentów specyficznych, podkomponenty mogą mieć storybooka ale nie muszą.

screenshot-20200729120901.png

I jak najbardziej wszystko musi mieć znaczące nazwy, jeśli nie jesteś w stanie wymyślić znaczącej nazwy może to oznaczać że albo komponent robi za dużo albo za mało.

Dzięki. To mi całkiem sporo wyjaśnia, zwłaszcza podejście do nazwy. W tej chwili w komponencie w jednym pliku mam funkcje np. unconnectedSort i Sort - pierwsza jest funkcją jako taką a druga efektem potraktowania jej reduksową funkcją connect. Przedtem ta poczatkowa miała nazwę _Sort ale wyczytałam, że to zarezerwowane dla Lodasha raczej. Właściwie jedną rzecz mam zupełnie inaczej -style, są całkowicie osobno.

DO
Ale jeszcze pytanie - w tym co powyżej nie ma funkcji .js /ts. Pytanie, gdzie są? Czy jeżeli funkcja jest używana przez dokładnie jeden komponent powinna trafić do folderu tego komponentu (jak .css) czy nie? A funkcja używana tylko przez reducer? Jakiś folder 'common'?
  • Rejestracja:ponad 5 lat
  • Ostatnio:ponad 4 lata
  • Postów:13
0

Jako, że zamiast używać CRA stawiam Reacta na NX'sie to już na start jest rozdzielenie na aplikację, np: /web-main i /libs. W libs trzymam wszystkie rzeczy wielokrotnego użytku jak np redux, czy jakieś uniwersalne komponenty. Folder aplikacji jest u mnie odpowiednikiem /pages. Wewnątrz mam main.tsx do głównych konfiguracj, dalej auth.tsx do oidc i app.tsx, w którym obsługuję routing. Pojedyncze strony trzymam w oddzielnych katalogach i jak mam np listę projektów to mam /projects-list i w środku komponenty powiązane, często też w oddzielnych katalogach. Jeśli robię sobie formularz składający się z kilku kroków staram się opierać na tym https://github.com/eduwebpl/kurs-react-techniki-zaawansowane/blob/03.5-finish/03/src/components/MultiStep/MultiStep.js. Wygodne w utrzymaniu jak do tej pory doświadczyłem.
Przykład drzewa plików:
apps
-> web-main
--> projects-list
---> projects-list.tsx
---> list
----> list.tsx
----> list.view.tsx
----> list.story.tsx
-> libs
--> redux
---> index.ts
---> lib
----> index.ts
----> store.ts
----> reducers.ts
----> epics.ts
----> types.ts
----> generic
-----> actions.ts
-----> epic.ts
-----> reducer.ts
-----> types.ts
-----> index.ts
----> projects
-----> actions.ts
-----> epic.ts
-----> reducer.ts
-----> types.ts
-----> index.ts

Kliknij, aby dodać treść...

Pomoc 1.18.8

Typografia

Edytor obsługuje składnie Markdown, w której pojedynczy akcent *kursywa* oraz _kursywa_ to pochylenie. Z kolei podwójny akcent **pogrubienie** oraz __pogrubienie__ to pogrubienie. Dodanie znaczników ~~strike~~ to przekreślenie.

Możesz dodać formatowanie komendami , , oraz .

Ponieważ dekoracja podkreślenia jest przeznaczona na linki, markdown nie zawiera specjalnej składni dla podkreślenia. Dlatego by dodać podkreślenie, użyj <u>underline</u>.

Komendy formatujące reagują na skróty klawiszowe: Ctrl+B, Ctrl+I, Ctrl+U oraz Ctrl+S.

Linki

By dodać link w edytorze użyj komendy lub użyj składni [title](link). URL umieszczony w linku lub nawet URL umieszczony bezpośrednio w tekście będzie aktywny i klikalny.

Jeżeli chcesz, możesz samodzielnie dodać link: <a href="link">title</a>.

Wewnętrzne odnośniki

Możesz umieścić odnośnik do wewnętrznej podstrony, używając następującej składni: [[Delphi/Kompendium]] lub [[Delphi/Kompendium|kliknij, aby przejść do kompendium]]. Odnośniki mogą prowadzić do Forum 4programmers.net lub np. do Kompendium.

Wspomnienia użytkowników

By wspomnieć użytkownika forum, wpisz w formularzu znak @. Zobaczysz okienko samouzupełniające nazwy użytkowników. Samouzupełnienie dobierze odpowiedni format wspomnienia, zależnie od tego czy w nazwie użytkownika znajduje się spacja.

Znaczniki HTML

Dozwolone jest używanie niektórych znaczników HTML: <a>, <b>, <i>, <kbd>, <del>, <strong>, <dfn>, <pre>, <blockquote>, <hr/>, <sub>, <sup> oraz <img/>.

Skróty klawiszowe

Dodaj kombinację klawiszy komendą notacji klawiszy lub skrótem klawiszowym Alt+K.

Reprezentuj kombinacje klawiszowe używając taga <kbd>. Oddziel od siebie klawisze znakiem plus, np <kbd>Alt+Tab</kbd>.

Indeks górny oraz dolny

Przykład: wpisując H<sub>2</sub>O i m<sup>2</sup> otrzymasz: H2O i m2.

Składnia Tex

By precyzyjnie wyrazić działanie matematyczne, użyj składni Tex.

<tex>arcctg(x) = argtan(\frac{1}{x}) = arcsin(\frac{1}{\sqrt{1+x^2}})</tex>

Kod źródłowy

Krótkie fragmenty kodu

Wszelkie jednolinijkowe instrukcje języka programowania powinny być zawarte pomiędzy obróconymi apostrofami: `kod instrukcji` lub ``console.log(`string`);``.

Kod wielolinijkowy

Dodaj fragment kodu komendą . Fragmenty kodu zajmujące całą lub więcej linijek powinny być umieszczone w wielolinijkowym fragmencie kodu. Znaczniki ``` lub ~~~ umożliwiają kolorowanie różnych języków programowania. Możemy nadać nazwę języka programowania używając auto-uzupełnienia, kod został pokolorowany używając konkretnych ustawień kolorowania składni:

```javascript
document.write('Hello World');
```

Możesz zaznaczyć również już wklejony kod w edytorze, i użyć komendy  by zamienić go w kod. Użyj kombinacji Ctrl+`, by dodać fragment kodu bez oznaczników języka.

Tabelki

Dodaj przykładową tabelkę używając komendy . Przykładowa tabelka składa się z dwóch kolumn, nagłówka i jednego wiersza.

Wygeneruj tabelkę na podstawie szablonu. Oddziel komórki separatorem ; lub |, a następnie zaznacz szablonu.

nazwisko;dziedzina;odkrycie
Pitagoras;mathematics;Pythagorean Theorem
Albert Einstein;physics;General Relativity
Marie Curie, Pierre Curie;chemistry;Radium, Polonium

Użyj komendy by zamienić zaznaczony szablon na tabelkę Markdown.

Lista uporządkowana i nieuporządkowana

Możliwe jest tworzenie listy numerowanych oraz wypunktowanych. Wystarczy, że pierwszym znakiem linii będzie * lub - dla listy nieuporządkowanej oraz 1. dla listy uporządkowanej.

Użyj komendy by dodać listę uporządkowaną.

1. Lista numerowana
2. Lista numerowana

Użyj komendy by dodać listę nieuporządkowaną.

* Lista wypunktowana
* Lista wypunktowana
** Lista wypunktowana (drugi poziom)

Składnia Markdown

Edytor obsługuje składnię Markdown, która składa się ze znaków specjalnych. Dostępne komendy, jak formatowanie , dodanie tabelki lub fragmentu kodu są w pewnym sensie świadome otaczającej jej składni, i postarają się unikać uszkodzenia jej.

Dla przykładu, używając tylko dostępnych komend, nie możemy dodać formatowania pogrubienia do kodu wielolinijkowego, albo dodać listy do tabelki - mogłoby to doprowadzić do uszkodzenia składni.

W pewnych odosobnionych przypadkach brak nowej linii przed elementami markdown również mógłby uszkodzić składnie, dlatego edytor dodaje brakujące nowe linie. Dla przykładu, dodanie formatowania pochylenia zaraz po tabelce, mogłoby zostać błędne zinterpretowane, więc edytor doda oddzielającą nową linię pomiędzy tabelką, a pochyleniem.

Skróty klawiszowe

Skróty formatujące, kiedy w edytorze znajduje się pojedynczy kursor, wstawiają sformatowany tekst przykładowy. Jeśli w edytorze znajduje się zaznaczenie (słowo, linijka, paragraf), wtedy zaznaczenie zostaje sformatowane.

  • Ctrl+B - dodaj pogrubienie lub pogrub zaznaczenie
  • Ctrl+I - dodaj pochylenie lub pochyl zaznaczenie
  • Ctrl+U - dodaj podkreślenie lub podkreśl zaznaczenie
  • Ctrl+S - dodaj przekreślenie lub przekreśl zaznaczenie

Notacja Klawiszy

  • Alt+K - dodaj notację klawiszy

Fragment kodu bez oznacznika

  • Alt+C - dodaj pusty fragment kodu

Skróty operujące na kodzie i linijkach:

  • Alt+L - zaznaczenie całej linii
  • Alt+, Alt+ - przeniesienie linijki w której znajduje się kursor w górę/dół.
  • Tab/⌘+] - dodaj wcięcie (wcięcie w prawo)
  • Shit+Tab/⌘+[ - usunięcie wcięcia (wycięcie w lewo)

Dodawanie postów:

  • Ctrl+Enter - dodaj post
  • ⌘+Enter - dodaj post (MacOS)