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

docs: ffileitem documentation added (refs SFKUI-7022) #251

Open
wants to merge 1 commit into
base: main
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
4 changes: 4 additions & 0 deletions docs/components/file-upload/FFileItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,7 @@ FFileItemIcons.vue
:::api
vue:FFileItem
:::

## Relaterat

- {@link FFileItemPageObject FFileItemPageObject}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import { FFileItemPageObject } from "@fkui/vue/pageobject";
import Example from "./FFileItemPageObject-type-of-file-icon.vue";

it("el() should select correct element", () => {
cy.mount(Example);

/* --- cut above --- */
const fileItemPdf = new FFileItemPageObject("[data-test=file-item-pdf]");
fileItemPdf.typeOfFileIcon().should("be.equal", "pdf");

const fileItemDoc = new FFileItemPageObject("[data-test=file-item-doc]");
fileItemDoc.typeOfFileIcon().should("be.equal", "doc");

const fileItemImage = new FFileItemPageObject(
"[data-test=file-item-image]",
);
fileItemImage.typeOfFileIcon().should("be.equal", "pic");
/* --- cut below --- */
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: FFileItemPageObject.typeOfFileIcon
title: "FFileItemPageObject: typeOfFileIcon() method"
short-title: typeOfFileIcon()
layout: article
---

Används för att komma åt namnet på filens ikon till exempel pdf, doc osv

## Syntax

```ts
typeOfFileIcon();
```

### Returvärde

`String` som innehåller en del av klassnamnet på filens ikon till exempel pdf, doc osv

## Exempel

```import static
FFileItemPageObject-type-of-file-icon.vue
```

```import
FFileItemPageObject-type-of-file-icon.cy.ts
```

## Relaterat

- {@link FFileItem}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<script setup lang="ts">
import { FFileItem } from "@fkui/vue";
</script>

<!-- cut above -->
<template>
<div>
<f-file-item v-test="'file-item-doc'" :file-name="'myFile.doc'" :mime-type="'application/msword'"></f-file-item>
</div>
<div>
<f-file-item v-test="'file-item-pdf'" :file-name="'myFile.pdf'" :mime-type="'application/pdf'"></f-file-item>
</div>
<div>
<f-file-item v-test="'file-item-image'" :file-name="'myFile.png'" :mime-type="'image/png'"></f-file-item>
</div>
</template>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { FFileItemPageObject } from "@fkui/vue/pageobject";
import Example from "./FFileItemPageObject.vue";

it("el() should select correct element", () => {
cy.mount(Example);

/* --- cut above --- */
const fileItem = new FFileItemPageObject("[data-test=file-item]");
fileItem.fileName().should("contain.text", ".pdf");
fileItem.typeOfFileIcon().should("be.equal", "pdf");

/* --- cut below --- */
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: FFileItemPageObject
title: "FFileItemPageObject: FFileItemPageObject() constructor"
short-title: FFileItemPageObject()
sortorder: 1
layout: article
---

Använd `FFileItemPageObject` för att hämta information relaterat till {@link FFileItem filpresentatören }.

## Syntax

```ts
new FFileItemPageObject(selector);
```

### Parametrar

`selector: string`
: Selector till `FFileItem` elementet. Du kan med fördel använda {@link TestPlugin `v-test`} direktivet för din selector.

## Publika variablar

`fileName` - filens namn inklusive filändelsen\
Copy link
Contributor

Choose a reason for hiding this comment

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

Jag tänker nog att dessa ska läggas ut som egna sidor precis som metoder, vad säger ni andra?

`fileIcon` - namnet på filens ikon\
`cancelDeleteButton` - "Avbryt"/"Ta bort" knapp element\
`progressMeter` - selektorn till förkoppsindikatorn (FProgressbar)

## Exempel

```import static
FFileItemPageObject.vue
```

```import
FFileItemPageObject.cy.ts
```

## Relaterat

- {@link FFileItem}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<script setup lang="ts">
import { FFileItem } from "@fkui/vue";
</script>

<!-- cut above -->
<template>
<div>
<f-file-item v-test="'file-item'" :file-name="'myFile.pdf'" :mime-type="'application/pdf'"></f-file-item>
</div>
</template>
Loading