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

[Component]: Breadcrumb Component (Work in progress) #861

Draft
wants to merge 51 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 36 commits
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
00f6477
init breadcrumb developement
mouadTaoussi Mar 4, 2024
a84de3f
init breadcrumb developement
mouadTaoussi Mar 6, 2024
39ad974
init breadcrumb developement
mouadTaoussi Mar 6, 2024
2b90fe6
init breadcrumb developement
mouadTaoussi Mar 7, 2024
882ea57
init breadcrumb developement
mouadTaoussi Mar 7, 2024
6a6be85
init breadcrumb developement
mouadTaoussi Mar 8, 2024
7a4cbcc
init breadcrumb developement
mouadTaoussi Mar 10, 2024
575ff24
init breadcrumb developement
mouadTaoussi Mar 10, 2024
640d6f1
init breadcrumb developement
mouadTaoussi Mar 14, 2024
f70d7dd
init breadcrumb developement
mouadTaoussi Mar 14, 2024
09ea8d9
init breadcrumb developement
mouadTaoussi Mar 14, 2024
dd27602
init breadcrumb developement
mouadTaoussi Mar 16, 2024
e8415c6
router-link, a tags; add more elements to the docs
mouadTaoussi Mar 20, 2024
01f9753
Merge branch 'develop' of https://github.com/mouadTaoussi/oruga into …
mouadTaoussi Mar 24, 2024
8376d97
Merge branch 'oruga-ui:develop' into breadcrumb
mouadTaoussi Mar 24, 2024
acfc6ba
prepare to Pull request
mouadTaoussi Mar 24, 2024
38fb1a6
prepare to Pull request
mouadTaoussi Mar 24, 2024
152facb
Merge branch 'breadcrumb' of https://github.com/mouadTaoussi/oruga in…
mouadTaoussi Mar 24, 2024
4efbb07
add inspector to docs
mouadTaoussi Mar 24, 2024
c3dd07d
Add descriptions for each prop, and improve them
mouadTaoussi Mar 25, 2024
d184468
change class prefix
mouadTaoussi Mar 25, 2024
dcdc4b3
Merge branch 'breadcrumb' of https://github.com/mouadTaoussi/oruga in…
mouadTaoussi Mar 25, 2024
410ff47
Merge branch 'develop' into breadcrumb
mouadTaoussi Mar 26, 2024
216ca1d
change config path
mouadTaoussi Mar 26, 2024
9b173a8
Merge branch 'breadcrumb' of https://github.com/mouadTaoussi/oruga in…
mouadTaoussi Mar 26, 2024
605a9d2
Merge branch 'oruga-ui:develop' into breadcrumb
mouadTaoussi Apr 20, 2024
e7662d4
Merge branch 'oruga-ui:develop' into breadcrumb
mouadTaoussi Apr 26, 2024
984e6a8
remove unnecessary code
mouadTaoussi Apr 26, 2024
48898e9
Merge branch 'breadcrumb' of https://github.com/mouadTaoussi/oruga in…
mouadTaoussi Apr 26, 2024
d44f0e9
prettier
mouadTaoussi Apr 26, 2024
759c2f7
change examples path
mouadTaoussi Apr 28, 2024
b916416
add more examples
mouadTaoussi Apr 30, 2024
3c9c588
add more examples
mouadTaoussi Apr 30, 2024
80cbd4b
finishing
mouadTaoussi May 1, 2024
1ede02f
changed active style
mouadTaoussi May 4, 2024
a06468f
changed active style and finishing
mouadTaoussi May 5, 2024
a037ab6
prepare tests
mouadTaoussi May 5, 2024
00727cd
prepare tests
mouadTaoussi Jun 20, 2024
416de14
prepare tests
mouadTaoussi Jun 20, 2024
9f40b16
prepare tests
mouadTaoussi Jun 24, 2024
724a633
prepare tests
mouadTaoussi Jun 24, 2024
b99948d
prepare tests
mouadTaoussi Jun 25, 2024
18ddf61
prepare tests
mouadTaoussi Jul 11, 2024
a1fbf54
Merge branch 'develop' of https://github.com/oruga-ui/oruga into orug…
mouadTaoussi Jul 11, 2024
2aee214
Merge branch 'oruga-ui-develop' into breadcrumb
mouadTaoussi Jul 11, 2024
0bb9baa
merge
mouadTaoussi Jul 11, 2024
49d619a
Merge branch 'oruga-ui:develop' into breadcrumb
mouadTaoussi Jul 13, 2024
ca0069c
Merge branch 'develop' into breadcrumb
mouadTaoussi Dec 6, 2024
11191e5
merge
mouadTaoussi Dec 6, 2024
290989f
finalising
mouadTaoussi Dec 13, 2024
292c730
Merge branch 'breadcrumb' of https://github.com/mouadTaoussi/oruga in…
mouadTaoussi Dec 13, 2024
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
29 changes: 7 additions & 22 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,8 @@
"conventional-changelog": "^5.1.0",
"conventional-changelog-cli": "^4.1.0",
"replace-in-file": "^7.1.0"
},
"dependencies": {
"jest-axe": "^8.0.0"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thats wrong here!

}
}
82 changes: 82 additions & 0 deletions packages/docs/components/Breadcrumb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: Breadcrumb
---

# Breadcrumb

<div class="vp-doc">

> The classic breadcrumb, in different colors, sizes, and states

</div>

<div class="vp-example">

## Examples

<example-breadcrumb />

</div>
<div class="vp-example">

## Class props

<inspector-breadcrumb-viewer />

</div>

<div class="vp-doc">

## Breadcrumb component

> The classic breadcrumb, in different colors, sizes, and states

```html
<o-breadcrumb></o-breadcrumb>
```

### Props

| Prop name | Description | Type | Values | Default |
| --------- | ------------------------------------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| align | Position of the breadcrumb | string | `left`, `center`, `right` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>breadcrumb: {<br>&nbsp;&nbsp;align: undefined<br>}</code> |
| override | Override existing theme classes completely | boolean | - | |
| separator | The breadcrumb separator between breadcrumb items | string | `has-arrow-separator`, `has-dot-separator`, `has-slash-separator`, `has-bullet-separator`, `has-succeeds-separator`, `has-chevron-separator` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>breadcrumb: {<br>&nbsp;&nbsp;separator: undefined<br>}</code> |
| size | Size of the breadcrumb | string | `small`, `medium`, `large` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>breadcrumb: {<br>&nbsp;&nbsp;size: undefined<br>}</code> |
| tag | Tag of the breadcrumb | DynamicComponent | `div`, `section ...` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>breadcrumb: {<br>&nbsp;&nbsp;tag: "section"<br>}</code> |

### Slots

| Name | Description | Bindings |
| ------- | ----------- | -------- |
| default | | |

</div>

<div class="vp-doc">

## Sass variables

<div class="theme-orugabase">

> Current theme ➜ _[Oruga Base](https://github.com/oruga-ui/theme-oruga)_

<p>The theme does not have any custom variables for this component.</p>
</div><div class="theme-orugafull">

> Current theme ➜ _[Oruga Full](https://github.com/oruga-ui/theme-oruga)_

<p>The theme does not have any custom variables for this component.</p>
</div><div class="theme-bulma">

> Current theme ➜ _[Bulma](https://github.com/oruga-ui/theme-bulma)_

<p>The theme does not have any custom variables for this component.</p>
</div><div class="theme-bootstrap">

> Current theme ➜ _[Bootstrap](https://github.com/oruga-ui/theme-bootstrap)_

<p>The theme does not have any custom variables for this component.</p>
</div>

</div>
61 changes: 61 additions & 0 deletions packages/docs/components/BreadcrumbItem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: Breadcrumb Item
---

# Breadcrumb Item

<div class="vp-doc">

> The classic breadrcumb item, in different colors, sizes, and states

</div>

<div class="vp-example">

## Examples

<example-breadcrumbitem />

</div>
<div class="vp-example">

## Class props

<inspector-breadcrumbitem-viewer />

</div>

<div class="vp-doc">

## BreadcrumbItem component

> The classic breadrcumb item, in different colors, sizes, and states

```html
<o-breadcrumb-item></o-breadcrumb-item>
```

### Props

| Prop name | Description | Type | Values | Default |
| ------------- | ------------------------------------------------------------ | ---------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| active | breadcrumb item is active, works only when tag provided is a | boolean | `true`, `false` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>breadcrumb: {<br>&nbsp;&nbsp;active: undefined<br>}</code> |
| activeVariant | | string | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>breadcrumb: {<br>&nbsp;&nbsp;activeVariant: undefined<br>}</code> |
| disabled | breadcrumb item is disabled | boolean | `true`, `false` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>breadcrumb: {<br>&nbsp;&nbsp;disabled: undefined<br>}</code> |
| iconBoth | | boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
| iconLeft | Icon name to show on the left | string | - | |
| iconPack | Icon pack to use | string | `mdi`, `fa`, `fas and any other custom icon pack` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>breadcrumb: {<br>&nbsp;&nbsp;iconPack: undefined<br>}</code> |
| iconRight | Icon name to show on the right | string | - | |
| tag | breadcrumb item tag name | DynamicComponent | `li`, `a`, `router-link`, `nuxt-link (or other nuxt alias)` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>breadcrumb: {<br>&nbsp;&nbsp;tag: "a"<br>}</code> |

### Slots

| Name | Description | Bindings |
| ------- | ----------- | -------- |
| default | | |

</div>

<div class="vp-doc">

</div>
Loading
Loading