@gravity-ui/blog-constructor 1.0.0 → 1.1.2

package/CHANGELOG.md

@@ -1,231 +1,38 @@
-# Change log
+# Changelog
 
-## 0.20.1
+## [1.1.2](https://github.com/gravity-ui/blog-constructor/compare/v1.1.1...v1.1.2) (2023-03-28)
 
-- Rewrite storybook on ts
 
-## 0.20.0
+### Bug Fixes
 
-- Install @gravity-ui linters
+* add info about release ([#19](https://github.com/gravity-ui/blog-constructor/issues/19)) ([8a5824f](https://github.com/gravity-ui/blog-constructor/commit/8a5824f24c4ad85f0f122111f8f5c1e7c36becc5))
 
-## 0.19.0
+## [1.1.1](https://github.com/gravity-ui/blog-constructor/compare/v1.1.0...v1.1.1) (2023-03-28)
 
-### Breaking changes
 
-- Refactor and rename types
-- Update react to 18.2.0
-- Update TS to 4.9.3
+### Bug Fixes
 
-## 0.18.1
+* add info about ci in readme ([#17](https://github.com/gravity-ui/blog-constructor/issues/17)) ([b6cffaa](https://github.com/gravity-ui/blog-constructor/commit/b6cffaa1c255c53cd00d06d4fbe0330e117f42a0))
 
-- Delete useless utils and small refactor
+## 1.1.0 (2023-03-28)
 
-## 0.18.0
+### Features
 
-### Breaking changes
+- add workflows, update @types/react, small refactors, update Select ([#2](https://github.com/gravity-ui/blog-constructor/issues/2)) ([326247a](https://github.com/gravity-ui/blog-constructor/commit/326247abe9411b50c82ed2cfa516ac6cd341bfa7))
+- Brush up stories, add content for CTA, Layout, Feed blocks. ([#4](https://github.com/gravity-ui/blog-constructor/issues/4)) ([0b73537](https://github.com/gravity-ui/blog-constructor/commit/0b73537b3bae35eca10610963369f3f5d8f9ecbd))
+- export author type ([9e5ee34](https://github.com/gravity-ui/blog-constructor/commit/9e5ee34c6b4d1b3288cda1258160e22073f9ad9d))
+- fix button savedOnly color ([#9](https://github.com/gravity-ui/blog-constructor/issues/9)) ([ef3b1ca](https://github.com/gravity-ui/blog-constructor/commit/ef3b1ca9048f1218817ec5c9c6a5b3e05492f062))
+- init tests ([#1](https://github.com/gravity-ui/blog-constructor/issues/1)) ([f8df32f](https://github.com/gravity-ui/blog-constructor/commit/f8df32f3eccb97abc7bfef222aca1ea56421619b))
+- **navigation:** pass the PageConstructor's navigation prop ([cb875ff](https://github.com/gravity-ui/blog-constructor/commit/cb875ff708832f5dd9e121d67cfccb387ae2499f))
+- uninstall doctools/components ([#14](https://github.com/gravity-ui/blog-constructor/issues/14)) ([16dc64c](https://github.com/gravity-ui/blog-constructor/commit/16dc64c3002b614831880dbe5b250c5637031c7d))
+- update license ([#3](https://github.com/gravity-ui/blog-constructor/issues/3)) ([aa4ee5b](https://github.com/gravity-ui/blog-constructor/commit/aa4ee5bdd01a7db5f6c6c457836658761eee1099))
+- update readme ([#15](https://github.com/gravity-ui/blog-constructor/issues/15)) ([3dbdf78](https://github.com/gravity-ui/blog-constructor/commit/3dbdf78b35f93024bebbcf64a6f06fb01509ae3e))
 
-- Refactor naming
+### Bug Fixes
 
-## 0.17.1
+- **general:** better deps ([8c22384](https://github.com/gravity-ui/blog-constructor/commit/8c223848e47faf8b9beee6700afce317359ee226))
+- search input width ([051c145](https://github.com/gravity-ui/blog-constructor/commit/051c14502110306964c4ec9a2bea47cea9364db5))
 
-- @gravity-ui/uikit 3.10.1 (fix share tooltip)
+## 1.0.0
 
-## 0.17.0
-
-- @gravity-ui/uikit 3.9.0
-
-## 0.16.1
-
-- Fix for treating page number on fetch
-
-## 0.16.0
-
-- Show "-" in filters selector switchers when only one broken filter provided in a query
-
-## 0.15.1
-
-- Do not show pointer cursor on save button title hover when the button is not clickable
-
-## 0.15.0
-
-- Prevent save button to be clickable when user is not logged in
-
-## 0.14.0
-
-- Refactor metaProps in BlogPostPage
-
-## 0.13.0
-
-- Remove temporal flag of icon selection
-
-## 0.12.4
-
-- Prevent collapse of a custom switcher on a blog feed
-
-## 0.12.2
-
-- Update types for getBlogPosts handler
-
-## 0.12.1
-
-- Render post card title via dangerouslySetInnerHTML
-
-## 0.12.0
-
-- Update page change logic when interactions with blog search panel
-
-## 0.11.1
-
-- **BlogYFM**: add `yfm_no-list-reset` class
-
-## 0.11.0
-
-- Refactor styles (kebab, prefix, variables)
-
-## 0.10.2
-
-- Add teamcity publish
-
-## 0.10.1
-
-- BlogPostTag types became Partial, BlogPostTagExtended is deleted
-
-## 0.10.0
-
-- add props for show support buttons in paginator
-
-## 0.9.2
-
-- added yfm headers weight style
-
-## 0.9.1
-
-- add specificity for search input styles
-
-## 0.9.0
-
-- add customization for sharing options in blog posts
-
-## 0.8.0
-
-- add BlogPage with gravity-ui requirements
-
-## 0.7.1
-
-- Add info about publish in readme
-
-## 0.7.0
-
-- Change packages @yandex-cloud => @gravity-ui
-- Remove i18n from peer dependencies
-
-## 0.6.30
-
-- add BlogPage
-
-## 0.5.10
-
-- fix yfm styles for table
-
-## 0.5.9
-
-- fix yfm styles
-
-## 0.5.8
-
-- delete selection of blog structure
-
-## 0.5.7
-
-- color variables updates
-
-## 0.5.6
-
-- change transformPostTags() routine
-
-## 0.5.5
-
-- add page-constructor in peer-dependencies
-
-## 0.5.3
-
-- fix yfm styles: add css variables to be able to redefine styles in projects
-
-## 0.5.2
-
-- condition for likes in cards
-
-## 0.5.1
-
-- refactor LocaleContext
-- refactor RouterContext
-- now likes is not required props
-
-## 0.4.3
-
-- Back previously patch
-
-## 0.4.2
-
-- Fix meta
-
-## 0.4.1
-
-- Fix share button
-- now region props is not required in TransformPageContentPropsType
-
-## 0.4.0
-
-- Add likes state update conditions
-
-## 0.3.1
-
-- Add metaData render condition
-
-## 0.3.0
-
-- Update props metaData
-
-## 0.2.3
-
-- Update types and namings
-
-## 0.2.2
-
-- Update styles
-
-## 0.2.1
-
-- Add default color for avatars (grey)
-
-## 0.2.0
-
-- Custom hook for likes
-
-- Change props for BlogPostPage
-  - delete:
-    - data
-  - add:
-    - likes
-    - content
-    - post
-
-## 0.1.0
-
-- Refactor business-logic BlogSuggets
-
-## 0.0.4
-
-- Delete extra requirements
-
-## 0.0.3
-
-- Refactor BlogContextProvider
-
-## 0.0.2
-
-- Meta fixes
-
-## 0.0.1
-
-- Create first version including Blog Post Page
+Create public access for blog-constructor library for creating blog format web pages.

package/README.md

@@ -1,4 +1,4 @@
-# @gravity-ui/blog-constructor ·
+# @gravity-ui/blog-constructor · [![npm package](https://img.shields.io/npm/v/@gravity-ui/blog-constructor)](https://www.npmjs.com/package/@gravity-ui/blog-constructor) [![CI](https://img.shields.io/github/actions/workflow/status/gravity-ui/blog-constructor/ci.yml?branch=main&label=CI)](https://github.com/gravity-ui/blog-constructor/actions/workflows/ci.yml?query=branch:main) [![CI](https://img.shields.io/github/actions/workflow/status/gravity-ui/blog-constructor/release.yml?branch=main&label=Release)](https://github.com/gravity-ui/blog-constructor/actions/workflows/release.yml?query=branch:main) [![storybook](https://img.shields.io/badge/Storybook-deployed-ff4685)](https://preview.yandexcloud.dev/blog-constructor/)
 
 ## Install
 
@@ -6,6 +6,68 @@
 npm install @gravity-ui/blog-constructor
 ```
 
+## Blog-constructor
+
+`Blog-constructor` is a library based on the [Page-constructor](https://github.com/gravity-ui/page-constructor) library for creating blog format web pages. Blog-constructor uses the [`custom`](https://github.com/gravity-ui/page-constructor#custom-blocks) prop from page-constructor to add the components needed for the blog.
+
+### Documentation - [storybook](https://preview.yandexcloud.dev/blog-constructor/)
+
+### Getting started
+
+The blog-constructor has both client components and server components for import. The blog pages is imported as a React component. To make sure it runs properly, wrap it in `BlogConstructorProvider`:
+
+```jsx
+import {BlogPage, BlogConstructorProvider} from '@gravity-ui/blog-constructor';
+
+// Main blog page
+<BlogConstructorProvider {...providerProps}>
+    <BlogPage
+        content={content}
+        posts={posts}
+        tags={tags}
+        getPosts={handleGetPosts}
+        settings={settings}
+    />
+</BlogConstructorProvider>
+
+---
+
+import {BlogPostPage, BlogConstructorProvider} from '@gravity-ui/blog-constructor';
+
+// Post page
+<BlogConstructorProvider {...providerProps}>
+    <BlogPostPage
+        content={content}
+        post={post}
+        suggestedPosts={suggestedPosts}
+        settings={settings}
+        shareOptions={shareOptions}
+    />
+</BlogConstructorProvider>
+
+```
+
+Also blog-constructor have server components to help you transform your data if you need
+
+```jsx
+import {
+  transformPost,
+  sanitizeMeta,
+  createReadableContent,
+  transformPageContent,
+} from '@gravity-ui/blog-constructor/server';
+```
+
+## i18n
+
+To make sure the i18n library used in your project runs properly, perform its initialization and set the project's current locale value in `lang`. For example:
+
+```typescript
+import {configure, Lang} from '@gravity-ui/blog-constructor';
+
+configure({lang: Lang.En});
+```
+
 ## Development
 
 ```bash

package/build/cjs/blocks/Author/Author.css

@@ -0,0 +1,31 @@
+/* use this for style redefinitions to awoid problems with
+unpredictable css rules order in build */
+.bc-author__layout {
+  display: flex;
+  align-items: flex-start;
+  flex-direction: row;
+  overflow: hidden;
+}
+@media (max-width: 1081px) {
+  .bc-author__layout {
+    width: 50%;
+  }
+}
+@media (max-width: 577px) {
+  .bc-author__layout {
+    width: 100%;
+  }
+}
+.bc-author__description {
+  color: var(--yc-color-text-primary);
+}
+.bc-author__content {
+  display: flex;
+  flex-wrap: wrap;
+  justify-content: flex-start;
+  align-content: flex-start;
+  position: relative;
+}
+.bc-author__container {
+  background-color: var(--yc-color-promo-base-silver);
+}

package/build/cjs/blocks/Banner/Banner.css

@@ -0,0 +1,58 @@
+/* use this for style redefinitions to awoid problems with
+unpredictable css rules order in build */
+.bc-banner {
+  margin-top: 16px;
+  padding-bottom: 16px;
+}
+.bc-banner__content {
+  width: 100%;
+  border-radius: var(--bc-border-radius);
+  position: relative;
+  display: flex;
+  flex-direction: row;
+}
+.bc-banner__container {
+  width: 100%;
+  border-radius: var(--bc-border-radius);
+  display: flex;
+  min-height: 220px;
+}
+.bc-banner__container_offset_large {
+  padding: calc(128px - 96px) 0 16px;
+  margin-bottom: -48px;
+}
+.bc-banner__info, .bc-banner__image {
+  flex: 1;
+}
+.bc-banner__info {
+  padding: 32px;
+  display: flex;
+  justify-content: space-between;
+  flex-direction: column;
+  align-items: baseline;
+}
+.bc-banner__image {
+  margin: var(--pc-image-padding);
+  border-radius: calc(var(--pc-border-radius) - var(--pc-image-padding));
+  width: calc(100% - 8px);
+  height: calc(100% - 8px);
+  object-fit: cover;
+}
+.bc-banner__image-container {
+  height: 100%;
+}
+.bc-banner__image-container_image-size_s {
+  width: 25%;
+}
+.bc-banner__image-container_image-size_m {
+  width: 50%;
+}
+@media (max-width: 577px) {
+  .bc-banner__content {
+    flex-direction: column;
+  }
+  .bc-banner__image-container_image-size_s, .bc-banner__image-container_image-size_m {
+    width: 100%;
+    height: 236px;
+  }
+}

package/build/cjs/blocks/CTA/CTA.css

@@ -0,0 +1,56 @@
+.bc-cta__card {
+  display: flex;
+  background-color: var(--yc-color-base-float);
+  border-radius: var(--bc-border-radius);
+  min-height: 80px;
+  align-content: center;
+  justify-content: center;
+  flex-direction: column;
+  flex-grow: 1;
+  padding: 32px;
+}
+.bc-cta__button {
+  display: flex;
+  padding-bottom: 16px;
+}
+.bc-cta__content {
+  display: flex;
+  flex-direction: column;
+}
+@media (min-width: 577px) {
+  .bc-cta__content {
+    display: flex;
+    flex-direction: row;
+  }
+  .bc-cta__button {
+    padding-bottom: 0px;
+  }
+  .bc-cta__button_layout {
+    width: 100%;
+    max-width: 100%;
+    margin-right: 0px;
+  }
+  .bc-cta__button_layout_2 {
+    width: calc(50% - (16px / 2));
+    max-width: 50%;
+    margin-right: 16px;
+  }
+  .bc-cta__button_layout_2:nth-child(2n) {
+    margin-right: 0px;
+  }
+  .bc-cta__button_layout_3 {
+    width: calc(33.3333333333% - (32px / 3));
+    margin-right: 16px;
+  }
+  .bc-cta__button_layout_3:nth-child(3n) {
+    margin-right: 0px;
+  }
+  .bc-cta__button_layout_4 {
+    width: calc(25% - (48px / 4));
+    max-width: 50%;
+    margin-right: 16px;
+  }
+  .bc-cta__button_layout_4:nth-child(4n) {
+    margin-right: 0px;
+  }
+}

package/build/cjs/blocks/ColoredText/ColoredText.css

@@ -0,0 +1,28 @@
+.bc-colored-text__container {
+  display: flex;
+  border-radius: var(--bc-border-radius);
+  overflow: hidden;
+  position: relative;
+}
+.bc-colored-text__picture-container {
+  position: absolute;
+  overflow: hidden;
+  width: 100%;
+  height: 100%;
+  border-radius: var(--bc-border-radius);
+  z-index: 1;
+  top: 0;
+  left: 0;
+}
+.bc-colored-text__picture {
+  object-fit: cover;
+  height: 100%;
+  width: 100%;
+}
+.bc-colored-text__text-content {
+  position: inherit;
+  z-index: 2;
+  height: 100%;
+  width: 100%;
+  padding: 32px;
+}

package/build/cjs/blocks/Layout/Layout.css

@@ -0,0 +1,22 @@
+/* use this for style redefinitions to awoid problems with
+unpredictable css rules order in build */
+.bc-layout {
+  margin: 0;
+  padding: 0;
+}
+.bc-layout__left-col.bc-layout__left-col {
+  padding: 0;
+}
+
+.bc-layout__right-col.bc-layout__right-col {
+  padding: 0;
+}
+
+.bc-layout__row {
+  padding: 0;
+  margin: 0;
+}
+.bc-layout__item {
+  margin: 0;
+  padding: 0 8px;
+}

package/build/cjs/blocks/Media/Media.css

@@ -0,0 +1,41 @@
+/* use this for style redefinitions to awoid problems with
+unpredictable css rules order in build */
+.bc-media__text-content {
+  padding-top: 16px;
+}
+.bc-media__container {
+  position: relative;
+  height: 100%;
+}
+.bc-media__border {
+  position: relative;
+  height: 100%;
+  width: 100%;
+  border-radius: calc(var(--bc-border-radius) + 1px);
+  border: 1px solid var(--yc-color-line-generic);
+  overflow: hidden;
+}
+.bc-media__content {
+  position: relative;
+  top: 0;
+  right: 0;
+  width: 100%;
+  height: 100%;
+  overflow: hidden;
+  object-fit: cover;
+  border-radius: var(--bc-border-radius);
+}
+.bc-media__video {
+  height: 100%;
+}
+.bc-media__video > video {
+  width: 100%;
+  height: auto;
+  border-radius: var(--bc-border-radius);
+}
+.bc-media__image {
+  width: 100%;
+  height: 100%;
+  object-fit: cover;
+  border-radius: var(--bc-border-radius);
+}

package/build/cjs/blocks/Meta/Meta.css

@@ -0,0 +1,7 @@
+.bc-meta {
+  padding: 0;
+  margin: 0;
+}
+.bc-meta__breadcrumbs {
+  display: inline-block;
+}

package/build/cjs/blocks/YFM/__tests__/YFM.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/cjs/blocks/YFM/__tests__/YFM.test.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importDefault(require("react"));
+const react_2 = require("@testing-library/react");
+const YFM_1 = require("../YFM");
+const text = 'YFM block';
+describe('YFM', () => {
+    test('Has id', async () => {
+        (0, react_2.render)(react_1.default.createElement(YFM_1.YFM, { text: text }));
+        const yfm = react_2.screen.getByText(text);
+        expect(yfm).toHaveClass('yfm');
+    });
+});

package/build/cjs/components/ButtonWithIcon/ButtonWithIcon.css

@@ -0,0 +1,76 @@
+/* use this for style redefinitions to awoid problems with
+unpredictable css rules order in build */
+.bc-button-with-icon {
+  display: inline-block;
+  margin: 0;
+  padding: 0;
+  font: inherit;
+  border: none;
+  outline: none;
+  color: inherit;
+  background: none;
+  cursor: pointer;
+  outline: none;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  transition: color 0.2s;
+}
+.utilityfocus .bc-button-with-icon:focus {
+  outline: 2px solid #ffdb4d;
+}
+.bc-button-with-icon_size_xs {
+  height: 24px;
+  width: 24px;
+}
+.bc-button-with-icon_size_s {
+  height: 28px;
+  width: 28px;
+}
+.bc-button-with-icon_size_m {
+  height: 32px;
+  width: 32px;
+}
+.bc-button-with-icon_size_n {
+  height: 36px;
+  width: 36px;
+}
+.bc-button-with-icon_theme_primary {
+  color: var(--www-text-content-color);
+  transition: color 0.2s;
+}
+.bc-button-with-icon_theme_primary:hover {
+  color: var(--yc-color-text-primary);
+}
+.bc-button-with-icon_theme_secondary {
+  color: var(--yc-color-text-secondary);
+  transition: color 0.2s;
+}
+.bc-button-with-icon_theme_secondary:hover {
+  color: var(--www-text-content-color);
+}
+.bc-button-with-icon_theme_link {
+  color: var(--www-text-content-color);
+  transition: color 0.2s;
+}
+.bc-button-with-icon_theme_link:hover {
+  color: var(--yc-color-text-link-hover);
+}
+.bc-button-with-icon_theme_accent {
+  color: var(--yc-color-text-yandex-red);
+  transition: opacity 0.2s;
+  opacity: 0.7;
+}
+.bc-button-with-icon_theme_accent:hover {
+  opacity: 1;
+}
+.bc-button-with-icon_disabled {
+  cursor: default;
+  color: var(--yc-color-text-secondary);
+}
+.bc-button-with-icon_disabled:hover {
+  color: var(--yc-color-text-secondary);
+}
+.mobile .bc-button-with-icon:hover {
+  color: inherit;
+}