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.

Sign up for GitHub

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

Jump to bottom

feat(NcNoteCard): Add text prop to pass the content of the note card #5894

Merged
merged 1 commit into from
Aug 3, 2024
Merged

feat(NcNoteCard): Add text prop to pass the content of the note card #5894

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 28 additions & 15 deletions src/components/NcNoteCard/NcNoteCard.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,31 @@ available in four versions:

When using an error type,

### Usage

```vue
<template>
<div>
<NcNoteCard type="warning">
<p>This is dangerous</p>
</NcNoteCard>
<NcNoteCard type="warning" text="This is dangerous" />

<NcNoteCard type="error" heading="Error">
<p>The server is not happy and reported the following error</p>
</NcNoteCard>
<NcNoteCard type="error"
heading="Error"
text="The server is not happy and reported the following error" />

<NcNoteCard type="success">
<p>You won</p>
</NcNoteCard>
<NcNoteCard type="success" text="You won" />

<NcNoteCard type="info">
<p>For your information</p>
</NcNoteCard>
<NcNoteCard type="info" text="For your information" />

<NcNoteCard type="warning">
<h4>Custom icon</h4>
<NcNoteCard type="warning" text="Custom icon usage">
<template #icon>
<Cog :size="20"/>
</template>
<p>Custom icon usage</p>
</NcNoteCard>

<h4>Custom content using the default slot</h4>
<NcNoteCard type="info">
Press <kbd>CTRL</kbd>+<kbd>C</kbd>
</NcNoteCard>
</div>
</template>
Expand Down Expand Up @@ -69,7 +70,12 @@ When using an error type,
<h2 v-if="heading">
{{ heading }}
</h2>
<slot />
<!-- @slot The main content (overwrites the `text` prop) -->
<slot>
<p class="notecard__text">
{{ text }}
</p>
</slot>
</div>
</div>
</template>
Expand Down Expand Up @@ -100,6 +106,13 @@ export default {
type: String,
default: '',
},
/**
* The message text of the note card
*/
text: {
type: String,
default: '',
},
},
computed: {
shouldShowAlert() {
Expand Down
Loading