Skip to content
This repository was archived by the owner on Aug 2, 2024. It is now read-only.

Commit 123d5ef

Browse files
fix: fixed docs + added new note
1 parent 092b7ab commit 123d5ef

File tree

4 files changed

+19
-12
lines changed

4 files changed

+19
-12
lines changed

src/components/Modal/modal.scss

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,23 @@
1212
// Default modal transition
1313
.fdv-modal-enter {
1414
opacity: 0;
15-
transform: scale3d(1, 1, 1) translate3d(0, -400px, 0);
1615
}
1716

1817
.fdv-modal-enter-to {
19-
transform: scale3d(1, 1, 1);
18+
opacity: 1;
2019
}
2120

2221
.fdv-modal-enter-active,
2322
.fdv-modal-leave-active {
24-
transition: 0.3s cubic-bezier(0.68, -0.55, 0.265, 1.55);
23+
opacity: 0;
2524
}
2625

2726
.fdv-modal-leave {
28-
transform: scale3d(1, 1, 1);
27+
opacity: 1;
2928
}
3029

3130
.fdv-modal-leave-to {
3231
opacity: 0;
33-
transform: scale3d(1, 1, 1) translate3d(0, -400px, 0);
3432
}
3533

3634
.fd-modal__content--overrides {

src/docs/content/en_us/master-details.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ fdRelatedComponents:
44
---
55
# Master Details
66

7+
::: tip CSS NEEDED & BETA NOTICE
8+
9+
The Master Details-related components require some additional CSS that is not part of Fundamental Styles. If you want to use the master detail-related components you have to inlude the extra **Fundamental Vue CSS** file. It is part of the NPM package in `dist`. It is also available at [https://unpkg.com/fundamental-vue](https://unpkg.com/fundamental-vue@latest/dist/FundamentalVue.umd.css)
10+
11+
The Master Details-related components are in **beta**.
12+
13+
:::
14+
715
This component provides a standardized master-details layout. The master section contains a list, whereas the details section's content is completely up to the developer. The `fd-master-details` component, exposes multiple props and slots allowing the consumer to customize the layout.
816

917

@@ -21,8 +29,8 @@ placed inside an `fd-modal` allowing the `master` section to take up all the ava
2129

2230
## Simple example
2331

24-
The simplest way to use it, would be by passing the `master-items` prop and populating the `details-content` slot (since it is empty by default).
25-
32+
The simplest way to use it, would be by passing the `master-items` prop and populating the `details-content` slot (since it is empty by default).
33+
2634
<d-example name="default">
2735
</d-example>
2836

@@ -31,13 +39,13 @@ The simplest way to use it, would be by passing the `master-items` prop and popu
3139
The component exposes `master-width` and `gap` props to control the with of the master column and that of the gap between the 2 columns. By default, the `master-width` is set to 50% and the `gap` is set to 0. The details column will always automatically take up the remaining space.
3240
You can pass the size that you want is either pixels or percentage, e.g: '50%', '20px'...
3341

34-
Use the sliders in the example below to see how the layout changes when changing the aforementioned props
42+
Use the sliders in the example below to see how the layout changes when changing the aforementioned props
3543
<d-example name="layout">
3644
</d-example>
3745

3846
## Using a Virtualized List
3947

40-
As we have mentioned before, the component can either user `fd-list-group` or `fd-virtualized-list` under the hood. To use the virtualized list, you need to set the `use-virtualized-list` prop to `true`. You can then pass an object that contains all the props that you would usually pass to the `fd-virtualized-list`. The `fd-master-details` uses a default configuration object which means you can choose to only pass the properties that you wish to override. The defaults are:
48+
As we have mentioned before, the component can either user `fd-list-group` or `fd-virtualized-list` under the hood. To use the virtualized list, you need to set the `use-virtualized-list` prop to `true`. You can then pass an object that contains all the props that you would usually pass to the `fd-virtualized-list`. The `fd-master-details` uses a default configuration object which means you can choose to only pass the properties that you wish to override. The defaults are:
4149

4250
```js
4351
defaultVirtualizedListConfig: {
@@ -61,7 +69,7 @@ defaultVirtualizedListConfig: {
6169

6270
## Slots
6371

64-
This component exposes multiple slots allowing you to customize the contents of the sections' title and content. You can see how the slots are positioned in the image below.
72+
This component exposes multiple slots allowing you to customize the contents of the sections' title and content. You can see how the slots are positioned in the image below.
6573

6674
![master-details-slots](../../../../public/images/master-details-slots.png)
6775

@@ -75,7 +83,7 @@ Below is an example making full use of all the available slots (it also simulate
7583
In order to ensure a more responsive design, the component exposes `auto-open-modal`, `mobile-modal-styles` and `mobile-breakpoints` props allowing the developer to control when should the `details` switch to an `fd-modal` and how should the modal look like. By default, the modal will be fullscreen and will be triggered on the `Breakpoints.XSmall` breakpoint.
7684

7785
Below is an example that makes use of these props to customize the mobile behavior of the component.
78-
86+
7987
<d-example name="mobile">
8088
</d-example>
8189

src/docs/index.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ import "prismjs/components/prism-markup.min";
2424
import "prismjs/components/prism-scss.min";
2525
import "prismjs/components/prism-css.min";
2626
import "prismjs/components/prism-bash.min";
27+
import "./../components/masterDetails/master-details.styles.scss";
2728

2829
const documentedComponents = getDocumentedComponents();
2930

yarn.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6154,7 +6154,7 @@ functional-red-black-tree@^1.0.1:
61546154
resolved "https://registry.yarnpkg.com/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz#1b0ab3bd553b2a0d6399d29c0e3ea0b252078327"
61556155
integrity sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=
61566156

6157-
fundamental-styles@^0.1.0:
6157+
61586158
version "0.1.0"
61596159
resolved "https://registry.yarnpkg.com/fundamental-styles/-/fundamental-styles-0.1.0.tgz#6e73945112e9639a6e366a6efbf5c1bab0aa1e94"
61606160
integrity sha512-nLC2ZMTmxhq4kvP4hypQkx7CnUlXfjYfE7KQJrX6D6zLpb1zAuIuwuEv/D2FEqDkir4T9/nYnYg+agW6T8Mt7Q==

0 commit comments

Comments
 (0)