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

🐛 74 muc comment limit initials length #81

Merged
merged 9 commits into from
May 15, 2024
Merged
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
14 changes: 7 additions & 7 deletions .storybook/MucTheme.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import { create } from '@storybook/theming/create';
import { create } from "@storybook/theming/create";

export default create({
base: 'light',
brandTitle: 'muc-patternlab-vue',
brandUrl: 'https://github.com/it-at-m/muc-patternlab-vue',
brandImage: './muc-patternlab-vue.png',
brandTarget: '_blank',
});
base: "light",
brandTitle: "muc-patternlab-vue",
brandUrl: "https://github.com/it-at-m/muc-patternlab-vue",
brandImage: "./muc-patternlab-vue.png",
brandTarget: "_blank",
});
8 changes: 4 additions & 4 deletions .storybook/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ import { StorybookConfig } from "@storybook/vue3-vite";
const fs = require("fs");
const path = require("path");
const mucIconsSvg = fs.readFileSync(
path.resolve(__dirname, "../public/assets/temporary/muc-icons.svg"),
"utf8"
path.resolve(__dirname, "../public/assets/temporary/muc-icons.svg"),
"utf8"
);
const customIconsSvg = fs.readFileSync(
path.resolve(__dirname, "../public/assets/temporary/custom-icons.svg"),
"utf8"
path.resolve(__dirname, "../public/assets/temporary/custom-icons.svg"),
"utf8"
);

const config: StorybookConfig = {
Expand Down
5 changes: 4 additions & 1 deletion .storybook/manager-head.html
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
<link rel="shortcut icon" href="/favicon.ico">
<link
rel="shortcut icon"
href="/favicon.ico"
/>
9 changes: 5 additions & 4 deletions .storybook/manager.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { addons } from '@storybook/manager-api';
import mucTheme from './MucTheme';
import { addons } from "@storybook/manager-api";

import mucTheme from "./MucTheme";

addons.setConfig({
theme: mucTheme,
});
theme: mucTheme,
});
2 changes: 1 addition & 1 deletion docs/GettingStarted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ In your Webcomponents root you should import the MDE5-CSS and SVG-Sprite for MDE
lang="ts"
setup
>
import mucIconsSprite from "@muenchen/muc-patternlab-vue/dist/assets/temporary/muc-icons.svg?raw";
import customIconsSprite from "@muenchen/muc-patternlab-vue/dist/assets/temporary/custom-icons.svg?raw";
import mucIconsSprite from "@muenchen/muc-patternlab-vue/dist/assets/temporary/muc-icons.svg?raw";
</script>

<template>
Expand Down
36 changes: 22 additions & 14 deletions docs/Iconography.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Meta, IconGallery, IconItem } from '@storybook/blocks';
import { IconGallery, IconItem, Meta } from "@storybook/blocks";

<Meta title="Iconography" />

Expand All @@ -9,16 +9,24 @@ This library already contains MDE5-Patternlabs iconset. The documentation to it
Additionally, it adds some specialty icons from [Pictogrammers](https://pictogrammers.com/library/mdi) which can be accessed by embedding the SVG-Sprite `custom-icons.svg` as described in [the getting started guide](/docs/getting-started--docs#setup).

<IconGallery>
<IconItem name="pencil">
<svg fill="currentColor"><use href="#icon-pencil" /></svg>
</IconItem>
<IconItem name="dots-vertical">
<svg fill="currentColor"><use href="#icon-dots-vertical" /></svg>
</IconItem>
<IconItem name="circle-off-outline">
<svg fill="currentColor"><use href="#icon-circle-off-outline" /></svg>
</IconItem>
<IconItem name="account">
<svg fill="currentColor"><use href="#icon-account" /></svg>
</IconItem>
</IconGallery>
<IconItem name="pencil">
<svg fill="currentColor">
<use href="#icon-pencil" />
</svg>
</IconItem>
<IconItem name="dots-vertical">
<svg fill="currentColor">
<use href="#icon-dots-vertical" />
</svg>
</IconItem>
<IconItem name="circle-off-outline">
<svg fill="currentColor">
<use href="#icon-circle-off-outline" />
</svg>
</IconItem>
<IconItem name="account">
<svg fill="currentColor">
<use href="#icon-account" />
</svg>
</IconItem>
</IconGallery>
2 changes: 1 addition & 1 deletion src/components/Card/MucCardContainer.vue
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<template>
<div class="container card-container">
<slot/>
<slot />
</div>
</template>

Expand Down
5 changes: 2 additions & 3 deletions src/components/Comment/MucComment.stories.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@ import MucComment from "./MucComment.vue";

export default {
component: MucComment,
title: "MucComment",
title: "Comment/MucComment",
tags: ["autodocs"],
parameters: {
docs: {
description: {
component: `The muc-comment component can be used to display a comment in e.g. a chat.
If you would like to display only text, we suggest using the more specific \`muc-comment-text\`.
For more general integration, we recommend the more general \`muc-comment\`.
The \`muc-comment\`-component is designed to be as generic as possible.

[🔗 Patternlab-Docs](https://patternlab.muenchen.space/?p=viewall-elements-comment)
`,
Expand Down
38 changes: 38 additions & 0 deletions src/components/Comment/MucCommentText.stories.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import MucCommentText from "./MucCommentText.vue";

export default {
component: MucCommentText,
title: "Comment/MucCommentText",
tags: ["autodocs"],
parameters: {
docs: {
description: {
component: `The muc-comment component can be used to display a comment in e.g. a chat.
If you would like to display only text, we suggest using this component instead of the more generic \`muc-comment\`.
Furthermore this component does limit the number of charactesr for the initials to two.

[🔗 Patternlab-Docs](https://patternlab.muenchen.space/?p=viewall-elements-comment)
`,
},
},
},
};

export const Default = {
args: {
rating: 4.2,
author: "Max Foo Bar Mustermann",
headline: "Initials shortend",
text: "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonum eirmod tempor invidunt ut",
},
};

export const Slider = {
args: {
...Default.args,
rating: 2.3,
author: "",
headline: "Empty Author",
variant: "slider",
},
};
22 changes: 15 additions & 7 deletions src/components/Comment/MucCommentText.vue
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ import { computed } from "vue";
import { MucComment } from "../index";
import CommentType from "./CommentType";

const AUTHOR_NAME_SEPERATOR = " ";

const props = withDefaults(
defineProps<{
datePrefix?: string;
Expand All @@ -31,22 +33,28 @@ const props = withDefaults(
headline?: string;
text: string;
rating: number;
variant: CommentType;
variant?: CommentType;
}>(),
{
datePrefix: "am",
variant: "listing",
}
);

/**
* Initials will be computed if none are given.
* In the case of an empty author field, an empty string is returned for the initials.
*/
const computedInitials = computed(() => {
return (
props.initials ??
props.author
.split(" ")
.map((word) => word.charAt(0))
.join("")
);
(
props.initials ??
props.author
.split(AUTHOR_NAME_SEPERATOR)
.map((word) => word.charAt(0))
.join("")
).match(/^.|.$/g) ?? [""]
).join("");
});
</script>

Expand Down
19 changes: 10 additions & 9 deletions src/components/Intro/MucIntro.vue
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,16 @@ defineSlots<{
</script>

<template>
<div class="m-intro m-intro-static-image" style="background-color: var(--color-neutrals-blue-xlight);">
<div
class="container"
>
<div
class="m-intro m-intro-static-image"
style="background-color: var(--color-neutrals-blue-xlight)"
>
<div class="container">
<div style="width: 66.6%">
<div>
<p
v-if="tagline"
class="m-intro-vertical__tagline"
v-if="tagline"
class="m-intro-vertical__tagline"
>
{{ tagline }}
</p>
Expand All @@ -41,12 +42,12 @@ defineSlots<{
</div>

<div
v-if="divider"
class="muc-divider"
v-if="divider"
class="muc-divider"
></div>

<div class="m-intro-vertical__content">
<p style="padding-bottom: 32px;">
<p style="padding-bottom: 32px">
<slot></slot>
</p>
</div>
Expand Down
Loading