Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Q-72: fix href props #167

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions preview/docs/Breadcrumbs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,24 @@ Breadcrumb navigation provides a list of links to all previous (parent) pages th

**Attention!**

- `Home • index` is the root page by default.
- This component should be on a nested page.
- Navigation will only work on the published site.

## 🧩 Components and Props

### In the interface

| Prop name | Default | Example |
| :-------- | :-----: | :-----: |
| Root page | `-` | `index` |
| Separator | `/` | `-` |
| Prop name | Default | Example |
| :-------- | :-----: | :--------: |
| Root page | `-` | `/foo/bar` |
| Separator | `/` | `-` |

### In the code (for developers)

| Prop name | Name in the code | Type | Default | Example |
| :-------- | :--------------: | :------: | :-----: | :-----: |
| Root page | `rootId` | `string` | `-` | `index` |
| Separator | `separator` | `string` | `/` | `-` |
| Prop name | Name in the code | Type | Default | Example |
| :-------- | :--------------: | :------: | :-----: | :--------: |
| Root page | `rootPath` | `string` | `-` | `/foo/bar` |
| Separator | `separator` | `string` | `/` | `-` |

## 🗄 GitHub

Expand Down
20 changes: 10 additions & 10 deletions preview/docs/Menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,19 @@ Add the component to the page and change the value of the `Maximum nesting` prop

### In the interface

| Prop name | Default | Example |
| :----------------------- | :-------: | :--------------: |
| Maximum nesting | `1` | `5` |
| Root page | `root` | `Your page name` |
| Mark parent active items | `Checked` | `Unchecked` |
| Prop name | Default | Example |
| :----------------------- | :--------: | :---------: |
| Maximum nesting | `1` | `5` |
| Root page | `rootPath` | `/foo` |
| Mark parent active items | `Checked` | `Unchecked` |

### In the code (for developers)

| Prop name | Name in the code | Type | Default | Example |
| :----------------------- | :------------------: | :-------: | :-----: | :--------------: |
| Maximum nesting | `depth` | `string` | `1` | `5` |
| Root page | `rootId` | `string` | `root` | `Your page name` |
| Mark parent active items | `exact-active-match` | `boolean` | `true` | `false` |
| Prop name | Name in the code | Type | Default | Example |
| :----------------------- | :------------------: | :-------: | :-----: | :-----: |
| Maximum nesting | `depth` | `string` | `1` | `5` |
| Root page | `rootPath` | `string` | `root` | `/foo` |
| Mark parent active items | `exact-active-match` | `boolean` | `true` | `false` |

## 🗄 GitHub

Expand Down
4 changes: 2 additions & 2 deletions preview/docs/MenuWithGroups.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ The `Root page ID` prop allows you to specify the page for which the menu will b
| Prop name | Default | Example |
| :-------------------------- | :----------------------------------: | :-----------------: |
| Maximum nesting | `10` | `5` |
| Root page | `-` | `index` |
| Root page | `-` | `/foo` |
| Groups condition by default | `Expand before the active menu item` | `Expand all groups` |

### In the code (for developers)

| Prop name | Name in the code | Type | Default | Example |
| :-------------------------- | :--------------: | :------: | :------------: | :---------: |
| Maximum nesting | `depth` | `string` | `10` | `5` |
| Root page | `root` | `string` | `-` | `index` |
| Root page | `root` | `string` | `-` | `/foo` |
| Groups condition by default | `tabState` | `enum` | `expandActive` | `expandAll` |

#### The 'Groups condition by default' property values
Expand Down
17 changes: 8 additions & 9 deletions preview/docs/ru/Breadcrumbs.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,24 @@

**Внимание**:

- `Home • index` является корневой страницей по умолчанию.
- Этот компонент должен быть на вложенной странице.
- Переход по ссылкам будет работать только на опубикованном сайте.

## 🧩 Компоненты и свойства

### В интерфейсе

| Названия свойств | По умолчанию | Пример |
| :---------------- | :----------: | :-----: |
| Корневая страница | `-` | `index` |
| Разделитель | `/` | `-` |
| Названия свойств | По умолчанию | Пример |
| :---------------- | :----------: | :--------: |
| Корневая страница | `-` | `/foo/bar` |
| Разделитель | `/` | `-` |

### В коде (для разработчиков)

| Названия свойств | Название в коде | Тип | По умолчанию | Пример |
| :---------------- | :-------------: | :------: | :----------: | :-----: |
| Корневая страница | `rootId` | `string` | `-` | `index` |
| Разделитель | `separator` | `string` | `/` | `-` |
| Названия свойств | Название в коде | Тип | По умолчанию | Пример |
| :---------------- | :-------------: | :------: | :----------: | :--------: |
| Корневая страница | `rootPath` | `string` | `-` | `/foo/bar` |
| Разделитель | `separator` | `string` | `/` | `-` |

## 🗄 GitHub

Expand Down
20 changes: 10 additions & 10 deletions preview/docs/ru/Menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,19 @@

### В интерфейсе

| Названия свойств | По умолчанию | Пример |
| :------------------------------------ | :----------: | :-----------------------: |
| Максимальная вложенность | `1` | `5` |
| Корневая страница | `root` | `Название вашей страницы` |
| Выделять родительские активные пункты | `Отмечен` | `Не отмечен` |
| Названия свойств | По умолчанию | Пример |
| :------------------------------------ | :----------: | :----------: |
| Максимальная вложенность | `1` | `5` |
| Корневая страница | `-` | `/foo` |
| Выделять родительские активные пункты | `Отмечен` | `Не отмечен` |

### В коде (для разработчиков)

| Названия свойств | Название в коде | Тип | По умолчанию | Пример |
| :------------------------------------ | :------------------: | :-------: | :----------: | :-----------------------: |
| Максимальная вложенность | `depth` | `string` | `1` | `5` |
| Корневая страница | `rootId` | `string` | `root` | `Название вашей страницы` |
| Выделять родительские активные пункты | `exact-active-match` | `boolean` | `true` | `false` |
| Названия свойств | Название в коде | Тип | По умолчанию | Пример |
| :------------------------------------ | :------------------: | :-------: | :----------: | :-----: |
| Максимальная вложенность | `depth` | `string` | `1` | `5` |
| Корневая страница | `rootPath` | `string` | `-` | `/foo` |
| Выделять родительские активные пункты | `exact-active-match` | `boolean` | `true` | `false` |

## 🗄 GitHub

Expand Down
4 changes: 2 additions & 2 deletions preview/docs/ru/MenuWithGroups.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ ID текущей страницы можно скопировать из адр
| Названия свойств | По умолчанию | Пример |
| :--------------------------- | :-------------------------------: | :-------------------: |
| Максимальная вложенность | `10` | `5` |
| Корневая страница | `-` | `index` |
| Корневая страница | `-` | `/foo` |
| Состояние групп по умолчанию | `Раскрыть перед активным пунктом` | `Раскрыть все группы` |

### В коде (для разработчиков)

| Названия свойств | Название в коде | Тип | По умолчанию | Пример |
| :--------------------------- | :-------------: | :------: | :------------: | :---------: |
| Максимальная вложенность | `depth` | `string` | `10` | `5` |
| Корневая страница | `root` | `string` | `-` | `index` |
| Корневая страница | `rootPath` | `string` | `-` | `/foo` |
| Состояние групп по умолчанию | `tabState` | `enum` | `expandActive` | `expandAll` |

#### Значения свойства 'Состояние групп по умолчанию'
Expand Down
6 changes: 3 additions & 3 deletions src/Breadcrumbs/Breadcrumbs.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ import { getItems } from './utils';

const isBrowser = typeof window !== 'undefined';

const Breadcrumbs = ({ separator, rootId, ...props }) => {
const Breadcrumbs = ({ separator, rootPath, ...props }) => {
const { override, rest } = useOverrides(props, overrides);

const items = useMemo(
() =>
getItems({
rootId,
rootPath,
separator,
override,
}),
[rootId, separator, override]
[rootPath, separator, override]
);

return (
Expand Down
1 change: 0 additions & 1 deletion src/Breadcrumbs/props/propsDefault.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
export default {
rootId: 'root',
separator: '/',
};
2 changes: 1 addition & 1 deletion src/Breadcrumbs/props/propsInfo.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
export default {
rootId: {
rootPath: {
title: {
en: 'Root page',
ru: 'Корневая страница',
Expand Down
4 changes: 2 additions & 2 deletions src/Breadcrumbs/utils/getItems.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import React from 'react';
import { Link, Text } from '@quarkly/widgets';
import getLinks from './getLinks';

const getItems = ({ rootId, separator, override }) => {
const { links, url } = getLinks({ rootId });
const getItems = ({ rootPath, separator, override }) => {
const { links, url } = getLinks(rootPath);

return links.map((link, i) => {
if (i !== links.length - 1) {
Expand Down
11 changes: 8 additions & 3 deletions src/Breadcrumbs/utils/getLinks.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { getAPI } from '../../utils';
import { getAPI, getPagesIdsByPath } from '../../utils';

const isBrowser = typeof window !== 'undefined';

const getLinks = ({ rootId }) => {
const getLinks = (path) => {
const { pages, mode } = getAPI();

if (!isBrowser || !pages)
Expand All @@ -11,7 +11,12 @@ const getLinks = ({ rootId }) => {
url: [],
};

const rootPage = pages[rootId];
const ids = getPagesIdsByPath(path);
const lastId = ids.pop();

if (!lastId) return { links: [], url: [] };

const rootPage = pages[lastId];

const names = Object.values(pages).reduce(
(prev, curr) => ({
Expand Down
37 changes: 8 additions & 29 deletions src/Menu.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import React from 'react';
import React, { useMemo } from 'react';
import atomize from '@quarkly/atomize';
import { useRouteMatch } from 'react-router-dom';
import { useMatch } from '@reach/router';
import { Link } from '@quarkly/widgets';
import { useOverrides } from '@quarkly/components';
import { getPagesIdsByPath, getAPI } from './utils';

const overrides = {
item: {
Expand Down Expand Up @@ -41,15 +42,6 @@ const overrides = {

const Ul = atomize.ul();
const Li = atomize.li();
const getAPI = () => {
if (typeof window !== 'undefined') {
return window.QAPI || {};
}
if (typeof global !== 'undefined') {
return global.QAPI || {};
}
return {};
};

const Item = ({
id,
Expand Down Expand Up @@ -128,27 +120,15 @@ const Wrapper = ({
);
};

const getParent = (pages, pageId) => {
if (!pageId || !pages[pageId]) return null;

return Object.values(pages).find(({ children = [] }) => {
return children && Array.isArray(children) && children.includes(pageId);
});
};

const Menu = ({ rootId, depth, 'exact-active-match': exact, ...props }) => {
const Menu = ({ rootPath, depth, 'exact-active-match': exact, ...props }) => {
const { override, rest } = useOverrides(props, overrides, defaultProps);
const pages = getAPI().pages || {};
let path = [];

if (rootId !== 'root') {
let parent = pages[rootId];
const [rootId, path] = useMemo(() => {
const p = rootPath ? getPagesIdsByPath(rootPath) : [];

while (parent && parent.id !== 'root') {
path = [parent.pageUrl, ...path];
parent = getParent(pages, parent?.id);
}
}
return [p[p.length - 1] ?? 'root', p.map((id) => pages[id]?.pageUrl)];
}, [rootPath, pages]);

return (
<Wrapper
Expand Down Expand Up @@ -177,7 +157,7 @@ const propInfo = {
category: 'Main',
weight: 1,
},
rootId: {
rootPath: {
title: {
en: 'Root page',
ru: 'Корневая страница',
Expand All @@ -199,7 +179,6 @@ const propInfo = {

const defaultProps = {
depth: 1,
rootId: 'root',
'exact-active-match': true,
};

Expand Down
40 changes: 8 additions & 32 deletions src/MenuWithGroups.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React, { useState, useEffect, useCallback } from 'react';
import React, { useState, useEffect, useCallback, useMemo } from 'react';

import atomize from '@quarkly/atomize';
import { useOverrides } from '@quarkly/components';
Expand All @@ -7,6 +7,7 @@ import { MdKeyboardArrowDown } from 'react-icons/md';

import { useRouteMatch } from 'react-router-dom';
import { useMatch } from '@reach/router';
import { getPagesIdsByPath, getAPI } from './utils';

const overrides = {
List: {
Expand Down Expand Up @@ -60,25 +61,6 @@ const overrides = {
},
};

const getAPI = () => {
if (typeof window !== 'undefined') {
return window.QAPI || {};
}
if (typeof global !== 'undefined') {
return global.QAPI || {};
}
return {};
};

const getParent = (pages, pageId) => {
if (!pageId || !pages[pageId]) return null;

return Object.values(pages).find(
({ children = [] }) =>
children && Array.isArray(children) && children.includes(pageId)
);
};

const Ul = atomize.ul();
const Li = atomize.li();

Expand Down Expand Up @@ -288,20 +270,15 @@ const List = ({
);
};

const MenuWithGroups = ({ depth, rootId, expand, tabState, ...props }) => {
const MenuWithGroups = ({ depth, rootPath, expand, tabState, ...props }) => {
const { override, rest } = useOverrides(props, overrides, defaultProps);
const pages = getAPI().pages || {};

let path = [];
const [rootId, path] = useMemo(() => {
const p = rootPath ? getPagesIdsByPath(rootPath) : [];

if (rootId !== 'root') {
let parent = pages[rootId];

while (parent && parent.id !== 'root') {
path = [parent.pageUrl, ...path];
parent = getParent(pages, parent?.id);
}
}
return [p[p.length - 1] ?? 'root', p.map((id) => pages[id]?.pageUrl)];
}, [rootPath, pages]);

return (
<List
Expand Down Expand Up @@ -333,7 +310,7 @@ const propInfo = {
category: 'Main',
weight: 1,
},
rootId: {
rootPath: {
title: {
en: 'Root page',
ru: 'Корневая страница',
Expand Down Expand Up @@ -383,7 +360,6 @@ const propInfo = {
};

const defaultProps = {
rootId: 'root',
depth: 10,
tabState: 'expandActive',
};
Expand Down
Loading