mirror of https://github.com/abpframework/abp.git
Yunus Emre Kalkan
6 years ago
472 changed files with 14184 additions and 1927 deletions
@ -0,0 +1,14 @@ |
|||
{ |
|||
"culture": "en-GB", |
|||
"texts": { |
|||
"Account": "ABP Account - Login & Register | ABP.IO", |
|||
"Welcome": "Welcome", |
|||
"UseOneOfTheFollowingLinksToContinue": "Use one of the following links to continue", |
|||
"FrameworkHomePage": "Framework home page", |
|||
"FrameworkDocumentation": "Framework documentation", |
|||
"OfficialBlog": "Official blog", |
|||
"CommercialHomePage": "Commercial home page", |
|||
"CommercialSupportWebSite": "Commercial support web site", |
|||
"CommunityWebSite": "ABP community web site" |
|||
} |
|||
} |
|||
@ -0,0 +1,202 @@ |
|||
{ |
|||
"culture": "en-GB", |
|||
"texts": { |
|||
"Permission:Organizations": "Organisations", |
|||
"Permission:Manage": "Manage Organisations", |
|||
"Permission:DiscountRequests": "Discount Requests", |
|||
"Permission:DiscountManage": "Manage Discount Requests", |
|||
"Permission:Disable": "Disable", |
|||
"Permission:Enable": "Enable", |
|||
"Permission:EnableSendEmail": "Enable Send Email", |
|||
"Permission:SendEmail": "Send Email", |
|||
"Permission:NpmPackages": "NPM Packages", |
|||
"Permission:NugetPackages": "Nuget Packages", |
|||
"Permission:Maintenance": "Maintenance", |
|||
"Permission:Maintain": "Maintain", |
|||
"Permission:ClearCaches": "Clear caches", |
|||
"Permission:Modules": "Modules", |
|||
"Permission:Packages": "Packages", |
|||
"Permission:Edit": "Edit", |
|||
"Permission:Delete": "Delete", |
|||
"Permission:Create": "Create", |
|||
"Permission:Accounting": "Accounting", |
|||
"Permission:Accounting:Quotation": "Quotation", |
|||
"Permission:Accounting:Invoice": "Invoice", |
|||
"Menu:Organizations": "Organisations", |
|||
"Menu:Accounting": "Accounting", |
|||
"Menu:Packages": "Packages", |
|||
"Menu:DiscountRequests": "Discount Requests", |
|||
"NpmPackageDeletionWarningMessage": "This NPM Package will be deleted. Please confirm this?", |
|||
"NugetPackageDeletionWarningMessage": "This Nuget Package will be deleted. Please confirm this?", |
|||
"ModuleDeletionWarningMessage": "This Module will be deleted. Please confirm this?", |
|||
"Name": "Name", |
|||
"DisplayName": "Display name", |
|||
"ShortDescription": "Short description", |
|||
"NameFilter": "Name", |
|||
"CreationTime": "Creation time", |
|||
"IsPro": "Is pro", |
|||
"ShowOnModuleList": "Show in module list", |
|||
"EfCoreConfigureMethodName": "Configure method name", |
|||
"IsProFilter": "Is pro", |
|||
"ApplicationType": "Application type", |
|||
"Target": "Target", |
|||
"TargetFilter": "Target", |
|||
"ModuleClass": "Module class", |
|||
"NugetPackageTarget.DomainShared": "Domain Shared", |
|||
"NugetPackageTarget.Domain": "Domain", |
|||
"NugetPackageTarget.Application": "Application", |
|||
"NugetPackageTarget.ApplicationContracts": "Application Contracts", |
|||
"NugetPackageTarget.HttpApi": "Http Api", |
|||
"NugetPackageTarget.HttpApiClient": "Http Api Client", |
|||
"NugetPackageTarget.Web": "Web", |
|||
"NugetPackageTarget.EntityFrameworkCore": "Delete Entity Framework Core", |
|||
"NugetPackageTarget.MongoDB": "MongoDB", |
|||
"Edit": "Edit", |
|||
"Delete": "Delete", |
|||
"Refresh": "Refresh", |
|||
"NpmPackages": "NPM Packages", |
|||
"NugetPackages": "Nuget Packages", |
|||
"NpmPackageCount": "NPM Package Count", |
|||
"NugetPackageCount": "Nuget Package Count", |
|||
"Module": "Modules", |
|||
"ModuleInfo": "Module info", |
|||
"CreateANpmPackage": "Create a NPM package", |
|||
"CreateAModule": "Create a module", |
|||
"CreateANugetPackage": "Create a Nuget package", |
|||
"AddNew": "Add new", |
|||
"PackageAlreadyExist{0}": "\"{0}\" package has already been added.", |
|||
"ModuleAlreadyExist{0}": "\"{0}\" module has already been added.", |
|||
"ClearCache": "Clear cache", |
|||
"SuccessfullyCleared": "Successfully cleared", |
|||
"Menu:NpmPackages": "NPM Packages", |
|||
"Menu:Modules": "Modules", |
|||
"Menu:Maintenance": "Maintenance", |
|||
"Menu:NugetPackages": "Nuget Packages", |
|||
"CreateAnOrganization": "Create an organisation", |
|||
"Organizations": "Organisations", |
|||
"LongName": "Long name", |
|||
"LicenseType": "License type", |
|||
"MissingLicenseTypeField": "The license type field is required!", |
|||
"LicenseStartTime": "License start time", |
|||
"LicenseEndTime": "License end time", |
|||
"AllowedDeveloperCount": "Allowed developer count", |
|||
"UserNameOrEmailAddress": "Username or email address", |
|||
"AddOwner": "Add owner", |
|||
"UserName": "Username", |
|||
"Email": "Email", |
|||
"Developers": "Developers", |
|||
"AddDeveloper": "Add developer", |
|||
"Create": "Create", |
|||
"UserNotFound": "User not found", |
|||
"{0}WillBeRemovedFromDevelopers": "{0} Will be removed from developers, please confirm?", |
|||
"{0}WillBeRemovedFromOwners": "{0} Will be removed from owners, please confirm?", |
|||
"Computers": "Computers", |
|||
"UniqueComputerId": "Unique computer id", |
|||
"LastSeenDate": "Last seen date", |
|||
"{0}Computer{1}WillBeRemovedFromRecords": "Computer of {0} ({1}) will be removed from records", |
|||
"OrganizationDeletionWarningMessage": "Organisation will be deleted", |
|||
"DeletingLastOwnerWarningMessage": "An organisation must have at least one owner, therefore you cannot remove this owner", |
|||
"This{0}AlreadyExistInThisOrganization": "{0} already exist in this organisation", |
|||
"AreYouSureYouWantToDeleteAllComputers": "Are you sure you want to delete all computers?", |
|||
"DeleteAll": "Delete all", |
|||
"DoYouWantToCreateNewUser": "Do you want to create new user?", |
|||
"MasterModules": "Master Modules", |
|||
"OrganizationName": "Organisation name", |
|||
"CreationDate": "Creation date", |
|||
"LicenseStartDate": "License start date", |
|||
"LicenseEndDate": "License end date", |
|||
"OrganizationNamePlaceholder": "Organisation name...", |
|||
"TotalQuestionCountPlaceholder": "Total question count...", |
|||
"RemainingQuestionCountPlaceholder": "Remaining question count...", |
|||
"LicenseTypePlaceholder": "License type...", |
|||
"CreationDatePlaceholder": "Creation date...", |
|||
"LicenseStartDatePlaceholder": "License start date...", |
|||
"LicenseEndDatePlaceholder": "License end date...", |
|||
"UsernameOrEmail": "Username or email", |
|||
"UsernameOrEmailPlaceholder": "Username or email...", |
|||
"Member": "Member", |
|||
"PurchaseOrderNo": "Purchase Order No.", |
|||
"QuotationDate": "Quotation date", |
|||
"CompanyName": "Company name", |
|||
"CompanyAddress": "Company address", |
|||
"Price": "Price", |
|||
"DiscountText": "Discount text", |
|||
"DiscountQuantity": "Discount quantity", |
|||
"DiscountPrice": "Discount price", |
|||
"Quotation": "Quotation", |
|||
"ExtraText": "Extra text", |
|||
"ExtraAmount": "Extra Amount", |
|||
"DownloadQuotation": "Download Quotation", |
|||
"Invoice": "Invoice", |
|||
"TaxNumber": "Tax No.", |
|||
"InvoiceNumber": "Invoice No.", |
|||
"InvoiceDate": "Invoice Date", |
|||
"InvoiceNote": "Invoice Note", |
|||
"Quantity": "Quantity", |
|||
"AddProduct": "Add Product", |
|||
"AddProductWarning": "You need to add a Product!", |
|||
"TotalPrice": "Total Price", |
|||
"Generate": "Generate", |
|||
"MissingQuantityField": "The Quantity field is required!", |
|||
"MissingPriceField": "The Price field is required!", |
|||
"CodeUsageStatus": "Status", |
|||
"Country": "Country", |
|||
"DeveloperCount": "Developer Count", |
|||
"RequestCode": "Request Code", |
|||
"WebSite": "Website", |
|||
"GithubUsername": "Github Username", |
|||
"PhoneNumber": "Phone Number", |
|||
"ProjectDescription": "Project Description", |
|||
"Referrer": "Referrer", |
|||
"DiscountRequests": "Discount Request", |
|||
"Copylink": "Copy Link", |
|||
"Disable": "Disable", |
|||
"Enable": "Enable", |
|||
"EnableSendEmail": "Enable Send Email", |
|||
"SendEmail": "Send Email", |
|||
"SuccessfullyDisabled": "Successfully disabled", |
|||
"SuccessfullyEnabled": "Successfully enabled", |
|||
"EmailSent": "Email sent", |
|||
"SuccessfullySent": "Successfully sent", |
|||
"SuccessfullyDeleted": "Successfully deleted", |
|||
"DiscountRequestDeletionWarningMessage": "Discount request will be deleted", |
|||
"BusinessType": "Business Type", |
|||
"TotalQuestionCount": "Total question count", |
|||
"RemainingQuestionCount": "Remaining question count", |
|||
"TotalQuestionMustBeGreaterWarningMessage": "TotalQuestionCount must be greater than RemainingQuestionCount!", |
|||
"QuestionCountsMustBeGreaterThanZero": "TotalQuestionCount and RemainingQuestionCount must be zero or greater than zero!", |
|||
"UnlimitedQuestionCount": "Unlimited question count", |
|||
"Notes": "Notes", |
|||
"Menu:Community": "Community", |
|||
"Menu:Articles": "Articles", |
|||
"Wait": "Wait", |
|||
"Approve": "Approve", |
|||
"Reject": "Reject", |
|||
"Details": "Details", |
|||
"Url": "Url", |
|||
"Title": "Title", |
|||
"ContentSource": "Content source", |
|||
"Status": "Status", |
|||
"ReadArticle": "Read article", |
|||
"ArticleHasBeenWaiting": "Article has been waiting", |
|||
"ArticleHasBeenApproved": "Article has been approved", |
|||
"ArticleHasBeenRejected": "Article has been rejected", |
|||
"Permission:Community": "Community", |
|||
"Permission:CommunityArticle": "Article", |
|||
"Link": "Link", |
|||
"Enum:ContentSource:0": "Github", |
|||
"Enum:ContentSource:1": "External", |
|||
"Enum:Status:0": "Waiting", |
|||
"Enum:Status:1": "Author name", |
|||
"Enum:Status:2": "Approved", |
|||
"Summary": "Summary", |
|||
"AuthorName": "Author", |
|||
"CoverImage": "Cover Image", |
|||
"RemoveCacheConfirmationMessage": "Are you sure you want remove the cache for \"{0}\" article?", |
|||
"SuccessfullyRemoved": "Successfully cleared", |
|||
"RemoveCache": "Remove Cache", |
|||
"Language": "Language", |
|||
"Optional": "Optional", |
|||
"CreateArticleLanguageInfo": "The language in which the article is written" |
|||
} |
|||
} |
|||
@ -0,0 +1,35 @@ |
|||
{ |
|||
"culture": "en-GB", |
|||
"texts": { |
|||
"Volo.AbpIo.Domain:010004": "Maximum member count reached!", |
|||
"Volo.AbpIo.Domain:010005": "Maximum owner count reached!", |
|||
"Volo.AbpIo.Domain:010006": "This user is already an owner in this organisation!", |
|||
"Volo.AbpIo.Domain:010007": "This user is already a developer in this organisation!", |
|||
"Volo.AbpIo.Domain:010008": "Allowed Developer Count can not be less then current developer count!", |
|||
"Volo.AbpIo.Domain:010009": "Allowed Developer Count can not be less then 0!", |
|||
"Volo.AbpIo.Domain:010010": "Maximum mac address count has been exceeded!", |
|||
"Volo.AbpIo.Domain:010011": "Personal license can't have more than 1 developer!", |
|||
"Volo.AbpIo.Domain:010012": "License can't be extended one month after license expires!", |
|||
"Volo.AbpIo.Domain:020001": "Couldn't delete this NPM Package because \"{NugetPackages}\" Nuget Packages are dependent to this package.", |
|||
"Volo.AbpIo.Domain:020002": "Couldn't delete this NPM Package because \"{Modules}\" Modules are using this package.", |
|||
"Volo.AbpIo.Domain:020003": "Couldn't delete this NPM Package because \"{Modules}\" Modules are using this package and \"{NugetPackages}\" Nuget Packages are dependent to this package.", |
|||
"Volo.AbpIo.Domain:020004": "Couldn't delete this Nuget Package because \"{Modules}\" Modules are using this package.", |
|||
"WantToLearn?": "Want to learn?", |
|||
"ReadyToGetStarted?": "Ready to get started?", |
|||
"JoinOurCommunity": "Join our community", |
|||
"GetStartedUpper": "GET STARTED", |
|||
"ForkMeOnGitHub": "Fork me on GitHub", |
|||
"Features": "Features", |
|||
"GetStarted": "Get Started", |
|||
"Documents": "Documents", |
|||
"Community": "Community", |
|||
"ContributionGuide": "Contribution Guide", |
|||
"Blog": "Blog", |
|||
"Commercial": "Commercial", |
|||
"MyAccount": "My account", |
|||
"Permission:License": "License", |
|||
"Permission:UserInfo": "User info", |
|||
"SeeDocuments": "See Documents", |
|||
"Samples": "Samples" |
|||
} |
|||
} |
|||
@ -0,0 +1,39 @@ |
|||
{ |
|||
"culture": "en-GB", |
|||
"texts": { |
|||
"OrganizationManagement": "Organisation Management", |
|||
"OrganizationList": "Organisation list", |
|||
"Volo.AbpIo.Commercial:010003": "You are not owner of this organisation!", |
|||
"OrganizationNotFoundMessage": "Organisation not found!", |
|||
"DeveloperCount": "Allocated / total developers", |
|||
"QuestionCount": "Remaining / total questions", |
|||
"Unlimited": "Unlimited", |
|||
"Owners": "Owners", |
|||
"AddMember": "Add member", |
|||
"AddOwner": "Add owner", |
|||
"AddDeveloper": "Add developer", |
|||
"UserName": "Username", |
|||
"Name": "Name", |
|||
"EmailAddress": "Email address", |
|||
"Developers": "Developers", |
|||
"LicenseType": "License type", |
|||
"Manage": "Manage", |
|||
"StartDate": "Start date", |
|||
"EndDate": "End date", |
|||
"Modules": "Modules", |
|||
"LicenseExtendMessage": "Your license end date is extended to {0}", |
|||
"LicenseUpgradeMessage": "Your license is upgraded to {0}", |
|||
"LicenseAddDeveloperMessage": "{0} developers added to your license", |
|||
"Volo.AbpIo.Commercial:010004": "Cannot find the specified user! The user must have already registered.", |
|||
"MyOrganizations": "My organisations", |
|||
"ApiKey": "API key", |
|||
"UserNameNotFound": "There is no user with username {0}", |
|||
"SuccessfullyAddedToNewsletter": "Thank you for subscribing to our newsletter!", |
|||
"MyProfile": "My Profile", |
|||
"EmailNotValid": "Please enter a valid email address.", |
|||
"JoinOurMarketingNewsletter": "Join our marketing newsletter", |
|||
"WouldLikeToReceiveMarketingMaterials": "I would like to receive marketing materials e.g. product deals & special offers.", |
|||
"StartUsingYourLicenseNow": "Start using your license now!", |
|||
"WelcomePage": "Welcome Page" |
|||
} |
|||
} |
|||
@ -0,0 +1,106 @@ |
|||
{ |
|||
"culture": "en-GB", |
|||
"texts": { |
|||
"Permission:CommunityArticle": "Community Article", |
|||
"Permission:Edit": "Edit", |
|||
"Waiting": "Waiting", |
|||
"Approved": "Approved", |
|||
"Rejected": "Rejected", |
|||
"Wait": "Wait", |
|||
"Approve": "Approve", |
|||
"Reject": "Reject", |
|||
"ReadArticle": "Read Article", |
|||
"Status": "Status", |
|||
"ContentSource": "Content Source", |
|||
"Details": "Details", |
|||
"Url": "Url", |
|||
"Title": "Title", |
|||
"CreationTime": "Creation time", |
|||
"Save": "Save", |
|||
"SameUrlAlreadyExist": "The Url already exists. If you want to add this article, you should change the url!", |
|||
"UrlIsNotValid": "Url is not valid.", |
|||
"UrlNotFound": "Url not found.", |
|||
"UrlContentNotFound": "Url content not found.", |
|||
"Summary": "Summary", |
|||
"MostRead": "Most Read", |
|||
"Latest": "Latest", |
|||
"ContributeAbpCommunity": "Contribute to the ABP Community", |
|||
"SubmitYourArticle": "Submit Your Article", |
|||
"ContributionGuide": "Contribution Guide", |
|||
"BugReport": "Bug Report", |
|||
"SeeAllArticles": "See All Articles", |
|||
"WelcomeToABPCommunity!": "Welcome to the ABP Community!", |
|||
"MyProfile": "My Profile", |
|||
"MyOrganizations": "My Organisations", |
|||
"EmailNotValid": "Please enter a valid email address.", |
|||
"FeatureRequest": "Feature Request", |
|||
"CreateArticleTitleInfo": "Title of the article to be shown on the article list.", |
|||
"CreateArticleUrlInfo": "Original GitHub/External URL of the article.", |
|||
"CreateArticleSummaryInfo": "A short summary of the article to be shown on the article list.", |
|||
"CreateArticleCoverInfo": "To create an effective article, add a cover photo and an upload 16:9 aspect ratio pictures for the best view (Maximum file size: 1MB)", |
|||
"ThisExtensionIsNotAllowed": "The extension is not allowed.", |
|||
"TheFileIsTooLarge": "The file is too large.", |
|||
"GoToTheArticle": "Go to the Article", |
|||
"Contribute": "Contribute", |
|||
"OverallProgress": "Overall Progress", |
|||
"Done": "Done", |
|||
"Open": "Open", |
|||
"Closed": "Closed", |
|||
"LatestQuestionOnThe": "Latest Question on the", |
|||
"Stackoverflow": "Stackoverflow", |
|||
"Votes": "votes", |
|||
"Answer": "Answer", |
|||
"Views": "views", |
|||
"Answered": "Answered", |
|||
"WaitingForYourAnswer": "Waiting for your answer", |
|||
"Asked": "asked", |
|||
"AllQuestions": "All Questions", |
|||
"NextVersion": "Next Version", |
|||
"MilestoneErrorMessage": "Couldn't get the current milestone details from Github.", |
|||
"QuestionItemErrorMessage": "Couldn't get the latest question details from Stackoverflow.", |
|||
"Oops": "Oops!", |
|||
"CreateArticleSuccessMessage": "The Article has been successfully submitted. It will be published once it has been reviewed by the site admin.", |
|||
"ChooseCoverImage": "Choose a cover image...", |
|||
"CoverImage": "Cover Image", |
|||
"ShareYourExperiencesWithTheABPFramework": "Share your experiences with the ABP Framework!", |
|||
"Optional": "Optional", |
|||
"UpdateUserWebSiteInfo": "Example: https://johndoe.com", |
|||
"UpdateUserTwitterInfo": "Example: johndoe", |
|||
"UpdateUserGithubInfo": "Example: johndoe", |
|||
"UpdateUserLinkedinInfo": "Example: https://www.linkedin.com/...", |
|||
"UpdateUserCompanyInfo": "Example: Volosoft", |
|||
"UpdateUserJobTitleInfo": "Example: Software Developer", |
|||
"UserName": "UserName", |
|||
"Company": "Company", |
|||
"PersonalWebsite": "Personal website", |
|||
"RegistrationDate": "Registration date", |
|||
"Social": "Social", |
|||
"Biography": "Biography", |
|||
"HasNoPublishedArticlesYet": "has no published articles yet", |
|||
"Author": "Author", |
|||
"LatestGithubAnnouncements": "Latest GitHub Announcements", |
|||
"SeeAllAnnouncements": "View all Announcements", |
|||
"LatestBlogPost": "Latest Blog Post", |
|||
"Edit": "Edit", |
|||
"ProfileImageChange": "Change the profile image", |
|||
"BlogItemErrorMessage": "Couldn't get the latest blog post details from ABP.", |
|||
"PlannedReleaseDate": "Planned release date", |
|||
"CommunityArticleRequestErrorMessage": "Couldn't get the latest article request from GitHub.", |
|||
"ArticleRequestFromGithubIssue": "There aren't any article requests at the moment.", |
|||
"LatestArticles": "Latest Articles", |
|||
"ArticleRequests": "Article Requests", |
|||
"AllArticleRequests": "See all Article requests", |
|||
"SubscribeToTheNewsletter": "Subscribe to the Newsletter", |
|||
"NewsletterEmailDefinition": "Receive information about what's happening in ABP; new releases, free sources, articles, and more.", |
|||
"NoThanks": "No thanks", |
|||
"MaybeLater": "Maybe later", |
|||
"JoinOurArticleNewsletter": "Join our article newsletter", |
|||
"Community": "Community", |
|||
"Marketing": "Marketing", |
|||
"CommunityPrivacyPolicyConfirmation": "I agree to the Terms & Conditions and <a href=\"https://commercial.abp.io/Privacy\">Privacy Policy</a>.", |
|||
"ArticleRequestMessageTitle": "<a href=\"https://github.com/abpframework/abp/issues/new\">Open an issue</a> on the GitHub to request an article/tutorial you want to see on this web site.", |
|||
"ArticleRequestMessageBody": "Here is the list of the requested articles by the Community. Do you want to write a requested article? Please click on the request and join the discussion.", |
|||
"Language": "Language", |
|||
"CreateArticleLanguageInfo": "The language in which the article is written" |
|||
} |
|||
} |
|||
@ -0,0 +1,197 @@ |
|||
{ |
|||
"culture": "en-GB", |
|||
"texts": { |
|||
"GetStarted": "Get Started - Startup Templates", |
|||
"Create": "Create", |
|||
"NewProject": "New Project", |
|||
"DirectDownload": "Direct Download", |
|||
"ProjectName": "Project name", |
|||
"ProjectType": "Project type", |
|||
"DatabaseProvider": "Database provider", |
|||
"NTier": "N-Tier", |
|||
"IncludeUserInterface": "Include user interface", |
|||
"CreateNow": "Create now", |
|||
"TheStartupProject": "The startup project", |
|||
"Tutorial": "Tutorial", |
|||
"UsingCLI": "Using CLI", |
|||
"SeeDetails": "See Details", |
|||
"AbpShortDescription": "ABP Framework is a complete infrastructure to create modern web applications by following the software development best practices and conventions.", |
|||
"SourceCodeUpper": "SOURCE CODE", |
|||
"LatestReleaseLogs": "Latest release logs", |
|||
"Infrastructure": "Infrastructure", |
|||
"Architecture": "Architecture", |
|||
"Modular": "Modular", |
|||
"DontRepeatYourself": "Don’t Repeat Yourself", |
|||
"DeveloperFocused": "Developer Focused", |
|||
"FullStackApplicationInfrastructure": "Full stack application infrastructure.", |
|||
"DomainDrivenDesign": "Domain Driven Design", |
|||
"DomainDrivenDesignExplanation": "Designed and developed based on DDD patterns and principles. Provides a layered model for your application.", |
|||
"Authorization": "Authorisation", |
|||
"AuthorizationExplanation": "Advanced authorisation with user, role and fine-grained permission system. Built on the Microsoft Identity library.", |
|||
"MultiTenancy": "Multi-Tenancy", |
|||
"MultiTenancyExplanationShort": "SaaS applications made easy! Integrated multi-tenancy from database to UI.", |
|||
"CrossCuttingConcerns": "Cross Cutting Concerns", |
|||
"CrossCuttingConcernsExplanationShort": "Complete infrastructure for authorization, validation, exception handling, caching, audit logging, transaction management and more.", |
|||
"BuiltInBundlingMinification": "Built-In Bundling & Minification", |
|||
"BuiltInBundlingMinificationExplanation": "No need to use external tools for bundling & minification. ABP offers a simpler, dynamic, powerful, modular and built-in way!", |
|||
"VirtualFileSystem": "Virtual File System", |
|||
"VirtualFileSystemExplanation": "Embed views, scripts, styles, images... into packages/libraries and reuse them in different applications.", |
|||
"Theming": "Theming", |
|||
"ThemingExplanationShort": "Use and customise the bootstrap-based standard UI theme or create your own.", |
|||
"BootstrapTagHelpersDynamicForms": "Bootstrap Tag Helpers & Dynamic Forms", |
|||
"BootstrapTagHelpersDynamicFormsExplanation": "Instead of manually writing bootstrap components, Use ABP's tag helpers to simplify and take advantage of intellisense. Quickly build UI forms based on a C# model using the dynamic form tag helper.", |
|||
"HTTPAPIsDynamicProxies": "HTTP APIs & Dynamic Proxies", |
|||
"HTTPAPIsDynamicProxiesExplanation": "Automatically expose application services as REST style HTTP APIs, and consume them with dynamic JavaScript and C# proxies.", |
|||
"CompleteArchitectureInfo": "Modern architecture to create maintainable software solutions.", |
|||
"DomainDrivenDesignBasedLayeringModelExplanation": "Helps you to implement a DDD based layered architecture and build a maintainable code base.", |
|||
"DomainDrivenDesignBasedLayeringModelExplanationCont": "Provides startup templates, abstractions, base classes, services, documentation and guides to help you to develop your application based on DDD patterns & principles.", |
|||
"MicroserviceCompatibleModelExplanation": "The core framework & pre-build modules are designed with microservice architecture in mind.", |
|||
"MicroserviceCompatibleModelExplanationCont": "Provides infrastructure, integrations, samples and documentation to implement microservice solutions easier, while it doesn’t bring additional complexity if you want a monolithic application.", |
|||
"ModularInfo": "ABP provides a module system that allows you to develop reusable application modules, tie into application lifecycle events, and express dependencies between core parts of your system.", |
|||
"PreBuiltModulesThemes": "Pre-Built Modules & Themes", |
|||
"PreBuiltModulesThemesExplanation": "Open source and commercial modules & themes are ready to use in your business application.", |
|||
"NuGetNPMPackages": "NuGet & NPM Packages", |
|||
"NuGetNPMPackagesExplanation": "Distributed as NuGet & NPM packages. Easy to install and upgrade.", |
|||
"ExtensibleReplaceable": "Extensible/Replaceable", |
|||
"ExtensibleReplaceableExplanation": "All services & modules are designed extensibility in mind. You can replace services, pages, styles and components.", |
|||
"CrossCuttingConcernsExplanation2": "Keep your codebase smaller so you can maintain focus on the code that’s specific to your business.", |
|||
"CrossCuttingConcernsExplanation3": "Don’t spend time implementing common application requirements on multiple projects.", |
|||
"AuthenticationAuthorization": "Authentication & Authorization", |
|||
"ExceptionHandling": "Exception Handling", |
|||
"Validation": "Validation", |
|||
"DatabaseConnection": "Database Connection", |
|||
"TransactionManagement": "Transaction management", |
|||
"AuditLogging": "Audit Logging", |
|||
"Caching": "Caching", |
|||
"Multitenancy": "Multitenancy", |
|||
"DataFiltering": "Data filtering", |
|||
"ConventionOverConfiguration": "Convention Over Configuration", |
|||
"ConventionOverConfigurationExplanation": "ABP implements common application conventions by default with a minimal or zero configuration.", |
|||
"ConventionOverConfigurationExplanationList1": "Auto registers known services to dependency injection.", |
|||
"ConventionOverConfigurationExplanationList2": "Exposes application services as HTTP APIs by naming conventions.", |
|||
"ConventionOverConfigurationExplanationList3": "Creates dynamic HTTP client proxies for C# and JavaScript.", |
|||
"ConventionOverConfigurationExplanationList4": "Provides default repositories for your entities.", |
|||
"ConventionOverConfigurationExplanationList5": "Manages Unit of Work per web request or application service method.", |
|||
"ConventionOverConfigurationExplanationList6": "Publishes create, update & delete events for your entities.", |
|||
"BaseClasses": "Base Classes", |
|||
"BaseClassesExplanation": "Pre-built base classes for common application patterns.", |
|||
"DeveloperFocusedExplanation": "ABP is for developers.", |
|||
"DeveloperFocusedExplanationCont": "It aims to simplify your daily software development while not restricting you from writing low level code.", |
|||
"SeeAllFeatures": "See All Features", |
|||
"CLI_CommandLineInterface": "CLI (Command Line Interface)", |
|||
"CLI_CommandLineInterfaceExplanation": "Includes a CLI to help you automate the creation of new projects and the addition of new modules.", |
|||
"StartupTemplates": "Startup Templates", |
|||
"StartupTemplatesExplanation": "Various startup templates provide a fully configured solution to jump start your development.", |
|||
"BasedOnFamiliarTools": "Based on Familiar Tools", |
|||
"BasedOnFamiliarToolsExplanation": "Built and integrated with popular tools you already know. Low learning curve, easy adaptation, comfortable development.", |
|||
"ORMIndependent": "ORM Independent", |
|||
"ORMIndependentExplanation": "The core framework is ORM/database independent and can work with any data source. Entity Framework Core and MongoDB providers are already available.", |
|||
"Features": "Explore the ABP Framework Features", |
|||
"ABPCLI": "ABP CLI", |
|||
"Modularity": "Modularity", |
|||
"BootstrapTagHelpers": "Bootstrap Tag Helpers", |
|||
"DynamicForms": "Dynamic Forms", |
|||
"BundlingMinification": "Bundling & Minification", |
|||
"BackgroundJobs": "Background Jobs", |
|||
"BackgroundJobsExplanation": "Define simple classes to execute jobs in the background as queued. Use the built-in job manager or integrate your own. <a href=\"{0}\">Hangfire</a> & <a href=\"{1}\">RabbitMQ</a> integrations are already available.", |
|||
"DDDInfrastructure": "DDD Infrastructure", |
|||
"DomainDrivenDesignInfrastructure": "Domain Driven Design Infrastructure", |
|||
"AutoRESTAPIs": "Auto REST APIs", |
|||
"DynamicClientProxies": "Dynamic Client Proxies", |
|||
"DistributedEventBus": "Distributed Event Bus", |
|||
"DistributedEventBusWithRabbitMQIntegration": "Distributed Event Bus with RabbitMQ Integration", |
|||
"TestInfrastructure": "Test Infrastructure", |
|||
"AuditLoggingEntityHistories": "Audit Logging & Entity Histories", |
|||
"ObjectToObjectMapping": "Object to Object Mapping", |
|||
"ObjectToObjectMappingExplanation": "<a href=\"{0}\">Object to object mapping</a> abstraction with AutoMapper integration.", |
|||
"EmailSMSAbstractions": "Email & SMS Abstractions", |
|||
"EmailSMSAbstractionsWithTemplatingSupport": "Email & SMS Abstractions with Templating Support", |
|||
"Localization": "Localization", |
|||
"SettingManagement": "Setting Management", |
|||
"ExtensionMethods": "Extension Methods", |
|||
"ExtensionMethodsHelpers": "Extension Methods & Helpers", |
|||
"AspectOrientedProgramming": "Aspect Oriented Programming", |
|||
"DependencyInjection": "Dependency Injection", |
|||
"DependencyInjectionByConventions": "Dependency Injection by Conventions", |
|||
"ABPCLIExplanation": "The ABP CLI (Command Line Interface) is a command line tool to perform common operations for ABP based solutions.", |
|||
"ModularityExplanation": "ABP provides a complete infrastructure to build your own application modules those may have entities, services, database integration, APIs, UI components and so on.", |
|||
"MultiTenancyExplanation": "ABP framework not only supports to develop multi-tenant applications, but also makes your code mostly unaware of the multi-tenancy.", |
|||
"MultiTenancyExplanation2": "Can automatically determine the current Tenant and isolate each Tenant's data from each other.", |
|||
"MultiTenancyExplanation3": "Supports single database, database per tenant and hybrid approaches.", |
|||
"MultiTenancyExplanation4": "You focus on your business code and let the framework to handle multi-tenancy on behalf of you.", |
|||
"BootstrapTagHelpersExplanation": "Instead of manually writing the repeating details of bootstrap components, use ABP's tag helpers to simplify and take advantage of intellisense. You can use Bootstrap whenever you need it.", |
|||
"DynamicFormsExplanation": "Dynamic form & input tag helpers can create the complete form from a C# class as the model.", |
|||
"AuthenticationAuthorizationExplanation": "Rich authentication & authorization options integrated to ASP.NET Core Identity & IdentityServer4. Provides an extensible & detailed permission system.", |
|||
"CrossCuttingConcernsExplanation": "Don't repeat yourself when implementing common features. Instead, focus on your business logic and let ABP automate by convention.", |
|||
"DatabaseConnectionTransactionManagement": "Database Connection & Transaction Management", |
|||
"CorrelationIdTracking": "Correlation-Id Tracking", |
|||
"BundlingMinificationExplanation": "ABP offers a simple, dynamic, powerful, modular and built-in bundling & minification system.", |
|||
"VirtualFileSystemnExplanation": "The Virtual File System makes it possible to manage files those do not physically exist on the file system (disk). It's mainly used to embed (js, css, image, cshtml...) files into assemblies and use them like physical files on runtime.", |
|||
"ThemingExplanation": "Theming system allows to develop your application & modules theme independent by defining a set of common base libraries and layouts, based on the latest Bootstrap framework.", |
|||
"DomainDrivenDesignInfrastructureExplanation": "A complete infrastructure to build layered applications based on the Domain Driven Design patterns & principles.", |
|||
"Specification": "Specification", |
|||
"Repository": "Repository", |
|||
"DomainService": "Domain Service", |
|||
"ValueObject": "Value Object", |
|||
"ApplicationService": "Application Service", |
|||
"DataTransferObject": "Data Transfer Object", |
|||
"AggregateRootEntity": "Aggregate Root, Entity", |
|||
"AutoRESTAPIsExplanation": "ABP can automagically configure your application services as API Controllers by convention.", |
|||
"DynamicClientProxiesExplanation": "Easily consume your APIs from JavaScript and C# clients.", |
|||
"DistributedEventBusWithRabbitMQIntegrationExplanation": "Easily publish & consume distributed events using built-in Distributed Event Bus with RabbitMQ integration available.", |
|||
"TestInfrastructureExplanation": "The framework has been developed unit & integration testing in mind. Provides you base classes to make it easier. Startup templates come with pre-configured for testing.", |
|||
"AuditLoggingEntityHistoriesExplanation": "Built-in audit logging for business-critical applications. Request, service, method level audit logging and entity histories with property-level details.", |
|||
"EmailSMSAbstractionsWithTemplatingSupportExplanation": "IEmailSender and ISmsSender abstractions decouples your application logic from the infrastructure. Advanced email template system allows to create & localize email templates and easily use whenever needed.", |
|||
"LocalizationExplanation": "Localization system allows to create resources in plain JSON files and use them to localize your UI. It supports advanced scenarios like inheritance, extensions and JavaScript integration while it is fully compatible with AspNet Core's localization system.", |
|||
"SettingManagementExplanation": "Define settings for your application and get values on runtime based on the current configuration, tenant and user.", |
|||
"ExtensionMethodsHelpersExplanation": "Don't repeat yourself even for trivial code parts. Extensions & helpers for standard types makes your code much cleaner and easy to write.", |
|||
"AspectOrientedProgrammingExplanation": "Provides a comfortable infrastructure to create dynamic proxies and implement Aspect Oriented Programming. Intercept any class and execute your code before & after every method execution.", |
|||
"DependencyInjectionByConventionsExplanation": "No need to register your classes to dependency injection manually. Automatically registers common service types by convention. For other type of services, you can use interfaces and attributes to make it easier and in-place.", |
|||
"DataFilteringExplanation": "Define and use data filters those are automatically applied when you query entities from database. Soft Delete & Multi-Tenant filters are provided out of the box when you implement simple interfaces.", |
|||
"PublishEvents": "Publish Events", |
|||
"HandleEvents": "Handle Events", |
|||
"AndMore": "and more...", |
|||
"Code": "Code", |
|||
"Result": "Result", |
|||
"SeeTheDocumentForMoreInformation": "See the <a href=\"{1}\">{0} document</a> for more information", |
|||
"IndexPageHeroSection": "<span class=\"first-line shine\"><strong>open source</strong></span><span class=\"second-line text-uppercase\">Web Application<br />Framework </span><span class=\"third-line shine2\"><strong>for asp.net core</strong></span>", |
|||
"UiFramework": "UI Framework", |
|||
"EmailAddress": "Email address", |
|||
"Mobile": "Mobile", |
|||
"ReactNative": "React Native", |
|||
"Strong": "Strong", |
|||
"Complete": "Complete", |
|||
"BasedLayeringModel": "Based Layering Model", |
|||
"Microservice": "Microservice", |
|||
"Compatible": "Compatible", |
|||
"MeeTTheABPCommunityInfo": "Our mission is to create an environment where developers can help each other with articles, tutorials, case studies, etc. and meet like-minded people.", |
|||
"JoinTheABPCommunityInfo": "Get involved with a vibrant community and become a contributor to the ABP Framework!", |
|||
"AllArticles": "All Articles", |
|||
"SubmitYourArticle": "Submit Your Article", |
|||
"DynamicClientProxyDocument": "See the dynamic client proxy documentations for <a href=\"{0}\">JavaScript</a> & <a href=\"{1}\">C#</a>.", |
|||
"EmailSMSAbstractionsDocument": "See the <a href=\"{0}\">emailing</a> and <a href=\"{1}\">SMS sending</a> documents for more information.", |
|||
"CreateProjectWizard": "This wizard creates a new project from the startup template which is properly configured to jump start to your project.", |
|||
"TieredOption": "Creates a tiered solution where Web and Http API layers are physically separated. If not checked, creates a layered solution which is less complex and suitable for most scenarios.", |
|||
"SeparateIdentityServerOption": "Separates server side into two applications: First one is for the identity server and the second one is for your server side HTTP API.", |
|||
"UseslatestPreVersion": "Uses latest pre-release version", |
|||
"ReadTheDocumentation": "<span class=\"text-primary\">Read</span><span class=\"text-success\">The Documentation</span>", |
|||
"Documentation": "Documentation", |
|||
"GettingStartedTutorial": "Getting Started Tutorial", |
|||
"ApplicationDevelopmentTutorial": "Application Development Tutorial", |
|||
"TheStartupTemplate": "The Startup Template", |
|||
"InstallABPCLIInfo": "ABP CLI is the fastest way to start a new solution with the ABP framework. Install the ABP CLI using a command line window:", |
|||
"DifferentLevelOfNamespaces": "You can use different level of namespaces; e.g. BookStore, Acme.BookStore or Acme.Retail.BookStore.", |
|||
"ABPCLIExamplesInfo": "<strong>new</strong> command creates a <strong>layered MVC application</strong> with <strong>Entity Framework Core</strong> as the database provider. However, it has additional options. Examples:", |
|||
"SeeCliDocumentForMoreInformation": "See the <a href=\"{0}\">ABP CLI document</a> for more options or select the \"Direct Download\" tab above.", |
|||
"Optional": "Optional", |
|||
"LocalFrameworkRef": "Keep local project reference for the framework packages.", |
|||
"BlobStoring": "BLOB Storing", |
|||
"BlobStoringExplanation": "BLOB Storing system provides an abstraction to work with BLOBs. ABP provides some pre-built storage provider integrations (Azure, AWS, File System, Database, etc.) that you can easily use in your applications.", |
|||
"TextTemplating": "Text Templating", |
|||
"TextTemplatingExplanation": "Text templating is used to dynamically render contents based on a template and a model (a data object). For example, you can use it to create dynamic email contents with a pre-built template.", |
|||
"MultipleUIOptions": "Multiple UI Options", |
|||
"MultipleDBOptions": "Multiple Database Providers", |
|||
"MultipleUIOptionsExplanation": "The core framework is designed as UI independent and can work with any type of UI system, while there are multiple pre-built and integrated options are provided out of the box.", |
|||
"MultipleDBOptionsExplanation": "The framework can work with any data source, while the following providers are officially developed and supported:" |
|||
} |
|||
} |
|||
@ -0,0 +1,320 @@ |
|||
# Data Table Column (or Entity Prop) Extensions for Angular UI |
|||
|
|||
|
|||
## Introduction |
|||
|
|||
Entity prop extension system allows you to add a new column to the data table for an entity or change/remove an already existing one. A "Name" column was added to the user management page below: |
|||
|
|||
<img alt="Entity Prop Extension Example: 'Name' Column" src="./images/entity-prop-extensions---name-column.gif" width="800px" style="max-width:100%"> |
|||
|
|||
You will have access to the current entity in your code and display its value, make the column sortable, perform visibility checks, and more. You can also render custom HTML in table cells. |
|||
|
|||
## How to Set Up |
|||
|
|||
In this example, we will add a "Name" column and display the value of the `name` field in the user management page of the [Identity Module](../../Modules/Identity.md). |
|||
|
|||
### Step 1. Create Entity Prop Contributors |
|||
|
|||
The following code prepares a constant named `identityEntityPropContributors`, ready to be imported and used in your root module: |
|||
|
|||
```js |
|||
// src/app/entity-prop-contributors.ts |
|||
|
|||
import { |
|||
eIdentityComponents, |
|||
IdentityEntityPropContributors, |
|||
IdentityUserDto, |
|||
} from '@abp/ng.identity'; |
|||
import { EntityProp, EntityPropList, ePropType } from '@abp/ng.theme.shared/extensions'; |
|||
|
|||
const nameProp = new EntityProp<IdentityUserDto>({ |
|||
type: ePropType.String, |
|||
name: 'name', |
|||
displayName: 'AbpIdentity::Name', |
|||
sortable: true, |
|||
columnWidth: 250, |
|||
}); |
|||
|
|||
export function namePropContributor(propList: EntityPropList<IdentityUserDto>) { |
|||
propList.addAfter(nameProp, 'userName', (value, name) => value.name === name); |
|||
} |
|||
|
|||
export const identityEntityPropContributors: IdentityEntityPropContributors = { |
|||
// enum indicates the page to add contributors to |
|||
[eIdentityComponents.Users]: [ |
|||
namePropContributor, |
|||
// You can add more contributors here |
|||
], |
|||
}; |
|||
|
|||
``` |
|||
|
|||
The list of props, conveniently named as `propList`, is a **doubly linked list**. That is why we have used the `addAfter` method, which adds a node with given value after the first node that has the previous value. You may find [all available methods here](../Common/Utils/Linked-List.md). |
|||
|
|||
### Step 2. Import and Use Entity Prop Contributors |
|||
|
|||
Import `identityEntityPropContributors` in your routing module and pass it to the static `forLazy` method of `IdentityModule` as seen below: |
|||
|
|||
```js |
|||
// src/app/app-routing.module.ts |
|||
|
|||
// other imports |
|||
import { identityEntityPropContributors } from './entity-prop-contributors'; |
|||
|
|||
const routes: Routes = [ |
|||
// other routes |
|||
|
|||
{ |
|||
path: 'identity', |
|||
loadChildren: () => |
|||
import('@abp/ng.identity').then(m => |
|||
m.IdentityModule.forLazy({ |
|||
entityPropContributors: identityEntityPropContributors, |
|||
}) |
|||
), |
|||
}, |
|||
|
|||
// other routes |
|||
]; |
|||
``` |
|||
|
|||
That is it, `nameProp` entity prop will be added, and you will see the "Name" column next to the usernames on the grid in the users page (`UsersComponent`) of the `IdentityModule`. |
|||
|
|||
## How to Render Custom HTML in Cells |
|||
|
|||
You can use the `valueResolver` to render an HTML string in the table. Imagine we want to show a red times icon (❌) next to unconfirmed emails and phones, instead of showing a green check icon next to confirmed emails and phones. The contributors below would do that for you. |
|||
|
|||
<img alt="Entity Prop Extension Example: Custom Cell Render" src="./images/entity-prop-extensions---custom-cell.gif" width="800px" style="max-width:100%"> |
|||
|
|||
```js |
|||
// src/app/entity-prop-contributors.ts |
|||
|
|||
import { |
|||
eIdentityComponents, |
|||
IdentityEntityPropContributors, |
|||
IdentityUserDto, |
|||
} from '@abp/ng.identity'; |
|||
import { EntityProp, EntityPropList } from '@abp/ng.theme.shared/extensions'; |
|||
import { of } from 'rxjs'; |
|||
|
|||
export function emailPropContributor(propList: EntityPropList<IdentityUserDto>) { |
|||
const index = propList.indexOf('email', (value, name) => value.name === name); |
|||
const droppedNode = propList.dropByIndex(index); |
|||
const emailProp = new EntityProp<IdentityUserDto>({ |
|||
...droppedNode.value, |
|||
valueResolver: data => { |
|||
const { email, emailConfirmed } = data.record; |
|||
const icon = email && !emailConfirmed ? `<i class="fa fa-times text-danger ml-1"></i>` : ''; |
|||
|
|||
return of((email || '') + icon); // should return an observable |
|||
}, |
|||
}); |
|||
|
|||
propList.addByIndex(emailProp, index); |
|||
} |
|||
|
|||
export function phonePropContributor(propList: EntityPropList<IdentityUserDto>) { |
|||
const index = propList.indexOf('phoneNumber', (value, name) => value.name === name); |
|||
const droppedNode = propList.dropByIndex(index); |
|||
const phoneProp = new EntityProp<IdentityUserDto>({ |
|||
...droppedNode.value, |
|||
valueResolver: data => { |
|||
const { phoneNumber, phoneNumberConfirmed } = data.record; |
|||
const icon = |
|||
phoneNumber && !phoneNumberConfirmed ? `<i class="fa fa-times text-danger ml-1"></i>` : ''; |
|||
|
|||
return of((phoneNumber || '') + icon); // should return an observable |
|||
}, |
|||
}); |
|||
|
|||
propList.addByIndex(phoneProp, index); |
|||
} |
|||
|
|||
export const identityEntityPropContributors: IdentityEntityPropContributors = { |
|||
[eIdentityComponents.Users]: [emailPropContributor, phonePropContributor], |
|||
}; |
|||
|
|||
``` |
|||
|
|||
> The `valueResolver` method should return an observable. You can wrap your return values with `of` from RxJS for that. |
|||
|
|||
## Object Extensions |
|||
|
|||
Extra properties defined on an existing entity will be included in the table based on their configuration. The values will also be mapped to and from `extraProperties` automatically. They are available when defining custom contributors, so you can drop, modify, or reorder them. The `isExtra` identifier will be set to `true` for these properties and will define this automatic behavior. |
|||
|
|||
## API |
|||
|
|||
### PropData\<R = any\> |
|||
|
|||
`PropData` is the shape of the parameter passed to all callbacks or predicates in an `EntityProp`. |
|||
|
|||
It has the following properties: |
|||
|
|||
- **record** is the row data, i.e. current value rendered in the table. |
|||
|
|||
```js |
|||
{ |
|||
type: ePropType.String, |
|||
name: 'name', |
|||
valueResolver: data => { |
|||
const name = data.record.name || ''; |
|||
return of(name.toUpperCase()); |
|||
}, |
|||
} |
|||
``` |
|||
|
|||
- **index** is the table index where the record is at. |
|||
|
|||
- **getInjected** is the equivalent of [Injector.get](https://angular.io/api/core/Injector#get). You can use it to reach injected dependencies of `ExtensibleTableComponent`, including, but not limited to, its parent component. |
|||
|
|||
```js |
|||
{ |
|||
type: ePropType.String, |
|||
name: 'name', |
|||
valueResolver: data => { |
|||
const restService = data.getInjected(RestService); |
|||
const usersComponent = data.getInjected(UsersComponent); |
|||
|
|||
// Use restService and usersComponent public props and methods here |
|||
}, |
|||
} |
|||
``` |
|||
|
|||
### PropCallback\<T, R = any\> |
|||
|
|||
`PropCallback` is the type of the callback function that can be passed to an `EntityProp` as `prop` parameter. A prop callback gets a single parameter, the `PropData`. The return type may be anything, including `void`. Here is a simplified representation: |
|||
|
|||
```js |
|||
type PropCallback<T, R = any> = (data?: PropData<T>) => R; |
|||
``` |
|||
|
|||
### PropPredicate\<T\> |
|||
|
|||
`PropPredicate` is the type of the predicate function that can be passed to an `EntityProp` as `visible` parameter. A prop predicate gets a single parameter, the `PropData`. The return type must be `boolean`. Here is a simplified representation: |
|||
|
|||
```js |
|||
type PropPredicate<T> = (data?: PropData<T>) => boolean; |
|||
``` |
|||
|
|||
### EntityPropOptions\<R = any\> |
|||
|
|||
`EntityPropOptions` is the type that defines required and optional properties you have to pass in order to create an entity prop. |
|||
|
|||
Its type definition is as follows: |
|||
|
|||
```js |
|||
type EntityPropOptions<R = any> = { |
|||
type: ePropType; |
|||
name: string; |
|||
displayName?: string; |
|||
valueResolver?: PropCallback<R, Observable<any>>; |
|||
sortable?: boolean; |
|||
columnWidth?: number; |
|||
permission?: string; |
|||
visible?: PropPredicate<R>; |
|||
}; |
|||
``` |
|||
|
|||
As you see, passing `type` and `name` is enough to create an entity prop. Here is what each property is good for: |
|||
|
|||
- **type** is the type of the prop value. It is used for custom rendering in the table. (_required_) |
|||
- **name** is the property name (or key) which will be used to read the value of the prop. (_required_) |
|||
- **displayName** is the name of the property which will be localized and shown as column header. (_default:_ `options.name`) |
|||
- **valueResolver** is a callback that is called when the cell is rendered. It must return an observable. (_default:_ `data => of(data.record[options.name])`) |
|||
- **sortable** defines if the table is sortable based on this entity prop. Sort icons are shown based on it. (_default:_ `false`) |
|||
- **columnWidth** defines a minimum width for the column. Good for horizontal scroll. (_default:_ `undefined`) |
|||
- **permission** is the permission context which will be used to decide if a column for this entity prop should be displayed to the user or not. (_default:_ `undefined`) |
|||
- **visible** is a predicate that will be used to decide if this entity prop should be displayed on the table or not. (_default:_ `() => true`) |
|||
|
|||
> Important Note: Do not use record in visibility predicates. First of all, the table header checks it too and the record will be `undefined`. Second, if some cells are displayed and others are not, the table will be broken. Use the `valueResolver` and render an empty cell when you need to hide a specific cell. |
|||
|
|||
You may find a full example below. |
|||
|
|||
### EntityProp\<R = any\> |
|||
|
|||
`EntityProp` is the class that defines your entity props. It takes an `EntityPropOptions` and sets the default values to the properties, creating an entity prop that can be passed to an entity contributor. |
|||
|
|||
```js |
|||
const options: EntityPropOptions<IdentityUserDto> = { |
|||
type: ePropType.String, |
|||
name: 'email', |
|||
displayName: 'AbpIdentity::EmailAddress', |
|||
valueResolver: data => { |
|||
const { email, emailConfirmed } = data.record; |
|||
|
|||
return of( |
|||
(email || '') + (emailConfirmed ? `<i class="fa fa-check text-success ml-1"></i>` : ''), |
|||
); |
|||
}, |
|||
sortable: true, |
|||
columnWidth: 250, |
|||
permission: 'AbpIdentity.Users.ReadSensitiveData', // hypothetical |
|||
visible: data => { |
|||
const store = data.getInjected(Store); |
|||
const selectSensitiveDataVisibility = ConfigState.getSetting( |
|||
'Abp.Identity.IsSensitiveDataVisible' // hypothetical |
|||
); |
|||
|
|||
return store.selectSnapshot(selectSensitiveDataVisibility).toLowerCase() === 'true'; |
|||
} |
|||
}; |
|||
|
|||
const prop = new EntityProp(options); |
|||
``` |
|||
|
|||
It also has two static methods to create its instances: |
|||
|
|||
- **EntityProp.create\<R = any\>\(options: EntityPropOptions\<R\>\)** is used to create an instance of `EntityProp`. |
|||
```js |
|||
const prop = EntityProp.create(options); |
|||
``` |
|||
- **EntityProp.createMany\<R = any\>\(options: EntityPropOptions\<R\>\[\]\)** is used to create multiple instances of `EntityProp` with given array of `EntityPropOptions`. |
|||
```js |
|||
const props = EntityProp.createMany(optionsArray); |
|||
``` |
|||
|
|||
### EntityPropList\<R = any\> |
|||
|
|||
`EntityPropList` is the list of props passed to every prop contributor callback as the first parameter named `propList`. It is a **doubly linked list**. You may find [all available methods here](../Common/Utils/Linked-List.md). |
|||
|
|||
The items in the list will be displayed according to the linked list order, i.e. from head to tail. If you want to re-order them, all you have to do is something like this: |
|||
|
|||
```js |
|||
export function reorderUserContributors( |
|||
propList: EntityPropList<IdentityUserDto>, |
|||
) { |
|||
// drop email node |
|||
const emailPropNode = propList.dropByValue( |
|||
'AbpIdentity::EmailAddress', |
|||
(prop, text) => prop.text === text, |
|||
); |
|||
|
|||
// add it back after phoneNumber |
|||
propList.addAfter( |
|||
emailPropNode.value, |
|||
'phoneNumber', |
|||
(value, name) => value.name === name, |
|||
); |
|||
} |
|||
``` |
|||
|
|||
### EntityPropContributorCallback\<R = any\> |
|||
|
|||
`EntityPropContributorCallback` is the type that you can pass as entity prop contributor callbacks to static `forLazy` methods of the modules. |
|||
|
|||
```js |
|||
export function isLockedOutPropContributor( |
|||
propList: EntityPropList<IdentityUserDto>, |
|||
) { |
|||
// add isLockedOutProp as 2nd column |
|||
propList.add(isLockedOutProp).byIndex(1); |
|||
} |
|||
|
|||
export const identityEntityPropContributors = { |
|||
[eIdentityComponents.Users]: [isLockedOutPropContributor], |
|||
}; |
|||
``` |
|||
|
|||
## See Also |
|||
|
|||
- [Customizing Application Modules Guide](../../Customizing-Application-Modules-Guide.md) |
|||
@ -0,0 +1,315 @@ |
|||
# Dynamic Form (or Form Prop) Extensions for Angular UI |
|||
|
|||
|
|||
## Introduction |
|||
|
|||
Form prop extension system allows you to add a new field to the create and/or edit forms for a form or change/remove an already existing one. A "Date of Birth" field was added to the user management page below: |
|||
|
|||
<img alt="Form Prop Extension Example: 'Date of Birth' Field" src="./images/form-prop-extensions---birthday-field.gif" width="800px" style="max-width:100%"> |
|||
|
|||
You can validate the field, perform visibility checks, and do more. You will also have access to the current entity when creating a contibutor for an edit form. |
|||
|
|||
## How to Set Up |
|||
|
|||
In this example, we will add a "Date of Birth" field in the user management page of the [Identity Module](../../Modules/Identity.md) and validate it. |
|||
|
|||
### Step 1. Create Form Prop Contributors |
|||
|
|||
The following code prepares two constants named `identityCreateFormPropContributors` and `identityEditFormPropContributors`, ready to be imported and used in your root module: |
|||
|
|||
```js |
|||
// src/app/form-prop-contributors.ts |
|||
|
|||
import { |
|||
eIdentityComponents, |
|||
IdentityCreateFormPropContributors, |
|||
IdentityUserDto, |
|||
} from '@abp/ng.identity'; |
|||
import { ePropType, FormProp, FormPropList } from '@abp/ng.theme.shared/extensions'; |
|||
import { Validators } from '@angular/forms'; |
|||
|
|||
const birthdayProp = new FormProp<IdentityUserDto>({ |
|||
type: ePropType.Date, |
|||
name: 'birthday', |
|||
displayName: 'AbpIdentity::Birthday', |
|||
validators: () => [Validators.required], |
|||
}); |
|||
|
|||
export function birthdayPropContributor(propList: FormPropList<IdentityUserDto>) { |
|||
propList.addByIndex(birthdayProp, 4); |
|||
} |
|||
|
|||
export const identityCreateFormPropContributors: IdentityCreateFormPropContributors = { |
|||
// enum indicates the page to add contributors to |
|||
[eIdentityComponents.Users]: [ |
|||
birthdayPropContributor, |
|||
// You can add more contributors here |
|||
], |
|||
}; |
|||
|
|||
export const identityEditFormPropContributors = identityCreateFormPropContributors; |
|||
// you may define different contributors for edit form if you like |
|||
|
|||
``` |
|||
|
|||
|
|||
The list of props, conveniently named as `propList`, is a **doubly linked list**. That is why we have used the `addByIndex` method, which adds the given value to the specified index of the list. You may find [all available methods here](../Common/Utils/Linked-List.md). |
|||
|
|||
### Step 2. Import and Use Form Prop Contributors |
|||
|
|||
Import `identityCreateFormPropContributors` and `identityEditFormPropContributors` in your routing module and pass it to the static `forLazy` method of `IdentityModule` as seen below: |
|||
|
|||
```js |
|||
// src/app/app-routing.module.ts |
|||
|
|||
// other imports |
|||
import { |
|||
identityCreateFormPropContributors, |
|||
identityEditFormPropContributors, |
|||
} from './form-prop-contributors'; |
|||
|
|||
const routes: Routes = [ |
|||
// other routes |
|||
|
|||
{ |
|||
path: 'identity', |
|||
loadChildren: () => |
|||
import('@abp/ng.identity').then(m => |
|||
m.IdentityModule.forLazy({ |
|||
createFormPropContributors: identityCreateFormPropContributors, |
|||
editFormPropContributors: identityEditFormPropContributors, |
|||
}) |
|||
), |
|||
}, |
|||
|
|||
// other routes |
|||
]; |
|||
``` |
|||
|
|||
That is it, `birthdayProp` form prop will be added, and you will see the datepicker for the "Date of Birth" field right before the "Email address" in the forms of the users page in the `IdentityModule`. |
|||
|
|||
## Object Extensions |
|||
|
|||
Extra properties defined on an existing entity will be included in the create and edit forms and validated based on their configuration. The form values will also be mapped to and from `extraProperties` automatically. They are available when defining custom contributors, so you can drop, modify, or reorder them. The `isExtra` identifier will be set to `true` for these properties and will define this automatic behavior. |
|||
|
|||
## API |
|||
|
|||
### PropData\<R = any\> |
|||
|
|||
`PropData` is the shape of the parameter passed to all callbacks or predicates in a `FormProp`. |
|||
|
|||
It has the following properties: |
|||
|
|||
- **getInjected** is the equivalent of [Injector.get](https://angular.io/api/core/Injector#get). You can use it to reach injected dependencies of `ExtensibleFormPropComponent`, including, but not limited to, its parent components. |
|||
|
|||
```js |
|||
{ |
|||
type: ePropType.Enum, |
|||
name: 'myField', |
|||
options: data => { |
|||
const restService = data.getInjected(RestService); |
|||
const usersComponent = data.getInjected(UsersComponent); |
|||
|
|||
// Use restService and usersComponent public props and methods here |
|||
} |
|||
}, |
|||
``` |
|||
|
|||
- **record** is the row data, i.e. current value of the selected item to edit. This property is _available only on edit forms_. |
|||
|
|||
```js |
|||
{ |
|||
type: ePropType.String, |
|||
name: 'myProp', |
|||
readonly: data => data.record.someOtherProp, |
|||
} |
|||
``` |
|||
|
|||
### PropCallback\<T, R = any\> |
|||
|
|||
`PropCallback` is the type of the callback function that can be passed to a `FormProp` as `prop` parameter. A prop callback gets a single parameter, the `PropData`. The return type may be anything, including `void`. Here is a simplified representation: |
|||
|
|||
```js |
|||
type PropCallback<T, R = any> = (data?: PropData<T>) => R; |
|||
``` |
|||
|
|||
### PropPredicate\<T\> |
|||
|
|||
`PropPredicate` is the type of the predicate function that can be passed to a `FormProp` as `visible` parameter. A prop predicate gets a single parameter, the `PropData`. The return type must be `boolean`. Here is a simplified representation: |
|||
|
|||
```js |
|||
type PropPredicate<T> = (data?: PropData<T>) => boolean; |
|||
``` |
|||
|
|||
### FormPropOptions\<R = any\> |
|||
|
|||
`FormPropOptions` is the type that defines required and optional properties you have to pass in order to create a form prop. |
|||
|
|||
Its type definition is as follows: |
|||
|
|||
```js |
|||
type FormPropOptions<R = any> = { |
|||
type: ePropType; |
|||
name: string; |
|||
displayName?: string; |
|||
id?: string; |
|||
permission?: string; |
|||
visible?: PropPredicate<R>; |
|||
readonly?: PropPredicate<R>; |
|||
disabled?: PropPredicate<R>; |
|||
validators?: PropCallback<R, ValidatorFn[]>; |
|||
asyncValidators?: PropCallback<R, AsyncValidatorFn[]>; |
|||
defaultValue?: boolean | number | string | Date; |
|||
options?: PropCallback<R, Observable<ABP.Option<any>[]>>; |
|||
autocomplete?: string; |
|||
isExtra? boolean; |
|||
}; |
|||
``` |
|||
|
|||
As you see, passing `type` and `name` is enough to create a form prop. Here is what each property is good for: |
|||
|
|||
- **type** is the type of the prop value. It defines which input is rendered for the prop in the form. (_required_) |
|||
- **name** is the property name (or key) which will be used to read the value of the prop. (_required_) |
|||
- **displayName** is the name of the property which will be localized and shown as column header. (_default:_ `options.name`) |
|||
- **id** will be set as the `for` attribute of the label and the `id` attribute of the input for the field. (_default:_ `options.name`) |
|||
- **permission** is the permission context which will be used to decide if a column for this form prop should be displayed to the user or not. (_default:_ `undefined`) |
|||
- **visible** is a predicate that will be used to decide if this prop should be displayed on the form or not. (_default:_ `() => true`) |
|||
- **readonly** is a predicate that will be used to decide if this prop should be readonly or not. (_default:_ `() => false`) |
|||
- **disabled** is a predicate that will be used to decide if this prop should be disabled or not. (_default:_ `() => false`) |
|||
- **validators** is a callback that returns validators for the prop. (_default:_ `() => []`) |
|||
- **asyncValidators** is a callback that returns async validators for the prop. (_default:_ `() => []`) |
|||
- **defaultValue** is the initial value the field will have. (_default:_ `null`) |
|||
- **options** is a callback that is called when a dropdown is needed. It must return an observable. (_default:_ `undefined`) |
|||
- **autocomplete** will be set as the `autocomplete` attribute of the input for the field. Please check [possible values](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete#Values). (_default:_ `'off'`) |
|||
- **isExtra** indicates this prop is an object extension. When `true`, the value of the field will be mapped from and to `extraProperties` of the entity. (_default:_ `undefined`) |
|||
|
|||
> Important Note: Do not use `record` property of `PropData` in create form predicates and callbacks, because it will be `undefined`. You can use it on edit form contributors though. |
|||
|
|||
You may find a full example below. |
|||
|
|||
### FormProp\<R = any\> |
|||
|
|||
`FormProp` is the class that defines your form props. It takes a `FormPropOptions` and sets the default values to the properties, creating a form prop that can be passed to a form contributor. |
|||
|
|||
```js |
|||
const options: FormPropOptions<IdentityUserDto> = { |
|||
type: ePropType.Enum, |
|||
name: 'myProp', |
|||
displayName: 'Default::MyPropName', |
|||
id: 'my-prop', |
|||
permission: 'AbpIdentity.Users.ReadSensitiveData', // hypothetical |
|||
visible: data => { |
|||
const store = data.getInjected(Store); |
|||
const selectSensitiveDataVisibility = ConfigState.getSetting( |
|||
'Abp.Identity.IsSensitiveDataVisible' // hypothetical |
|||
); |
|||
|
|||
return store.selectSnapshot(selectSensitiveDataVisibility).toLowerCase() === 'true'; |
|||
}, |
|||
readonly: data => data.record.someProp, |
|||
disabled: data => data.record.someOtherProp, |
|||
validators: () => [Validators.required], |
|||
asyncValidators: data => { |
|||
const http = data.getInjected(HttpClient); |
|||
|
|||
function validate(control: AbstractControl): Observable<ValidationErrors | null> { |
|||
if (control.pristine) return of(null); |
|||
|
|||
return http |
|||
.get('https://api.my-brand.io/hypothetical/endpoint/' + control.value) |
|||
.pipe(map(response => (response.valid ? null : { invalid: true }))); |
|||
} |
|||
|
|||
return [validate]; |
|||
}, |
|||
defaultValue: 0, |
|||
options: data => { |
|||
const service = data.getInjected(MyIdentityService); |
|||
|
|||
return service.getMyPropOptions() |
|||
.pipe( |
|||
map(({items}) => items.map( |
|||
item => ({key: item.name, value: item.id }) |
|||
)), |
|||
); |
|||
}, |
|||
autocomplete: 'off', |
|||
isExtra: true, |
|||
}; |
|||
|
|||
const prop = new FormProp(options); |
|||
``` |
|||
|
|||
It also has two static methods to create its instances: |
|||
|
|||
- **FormProp.create\<R = any\>\(options: FormPropOptions\<R\>\)** is used to create an instance of `FormProp`. |
|||
```js |
|||
const prop = FormProp.create(options); |
|||
``` |
|||
- **FormProp.createMany\<R = any\>\(options: FormPropOptions\<R\>\[\]\)** is used to create multiple instances of `FormProp` with given array of `FormPropOptions`. |
|||
```js |
|||
const props = FormProp.createMany(optionsArray); |
|||
``` |
|||
|
|||
### FormPropList\<R = any\> |
|||
|
|||
`FormPropList` is the list of props passed to every prop contributor callback as the first parameter named `propList`. It is a **doubly linked list**. You may find [all available methods here](../Common/Utils/Linked-List.md). |
|||
|
|||
The items in the list will be displayed according to the linked list order, i.e. from head to tail. If you want to re-order them, all you have to do is something like this: |
|||
|
|||
```js |
|||
export function reorderUserContributors( |
|||
propList: FormPropList<IdentityUserDto>, |
|||
) { |
|||
// drop email node |
|||
const emailPropNode = propList.dropByValue( |
|||
'AbpIdentity::EmailAddress', |
|||
(prop, displayName) => prop.displayName === displayName, |
|||
); |
|||
|
|||
// add it back after phoneNumber |
|||
propList.addAfter( |
|||
emailPropNode.value, |
|||
'phoneNumber', |
|||
(value, name) => value.name === name, |
|||
); |
|||
} |
|||
``` |
|||
|
|||
### CreateFormPropContributorCallback\<R = any\> |
|||
|
|||
`CreateFormPropContributorCallback` is the type that you can pass as **create form** prop contributor callbacks to static `forLazy` methods of the modules. |
|||
|
|||
```js |
|||
export function myPropCreateContributor( |
|||
propList: FormPropList<IdentityUserDto>, |
|||
) { |
|||
// add myProp as 2nd field from the start |
|||
propList.add(myProp).byIndex(1); |
|||
} |
|||
|
|||
export const identityCreateFormPropContributors = { |
|||
[eIdentityComponents.Users]: [myPropCreateContributor], |
|||
}; |
|||
``` |
|||
|
|||
### EditFormPropContributorCallback\<R = any\> |
|||
|
|||
`EditFormPropContributorCallback` is the type that you can pass as **edit form** prop contributor callbacks to static `forLazy` methods of the modules. |
|||
|
|||
```js |
|||
export function myPropEditContributor( |
|||
propList: FormPropList<IdentityUserDto>, |
|||
) { |
|||
// add myProp as 2nd field from the end |
|||
propList.add(myProp).byIndex(-1); |
|||
} |
|||
|
|||
export const identityEditFormPropContributors = { |
|||
[eIdentityComponents.Users]: [myPropEditContributor], |
|||
}; |
|||
``` |
|||
|
|||
## See Also |
|||
|
|||
- [Customizing Application Modules Guide](../../Customizing-Application-Modules-Guide.md) |
|||
@ -0,0 +1,400 @@ |
|||
# Entity Action Extensions for Angular UI |
|||
|
|||
## Introduction |
|||
|
|||
Entity action extension system allows you to add a new action to the action menu for an entity. A "Click Me" action was added to the user management page below: |
|||
|
|||
<img alt="Entity Action Extension Example: 'Click Me!' Action" src="./images/entity-action-extensions---click-me.gif" width="800px" style="max-width:100%"> |
|||
|
|||
You can take any action (open a modal, make an HTTP API call, redirect to another page... etc) by writing your custom code. You can also access the current entity in your code. |
|||
|
|||
## How to Set Up |
|||
|
|||
In this example, we will add a "Click Me!" action and alert the current row's `userName` in the user management page of the [Identity Module](../../Modules/Identity.md). |
|||
|
|||
### Step 1. Create Entity Action Contributors |
|||
|
|||
The following code prepares a constant named `identityEntityActionContributors`, ready to be imported and used in your root module: |
|||
|
|||
```js |
|||
// src/app/entity-action-contributors.ts |
|||
|
|||
import { |
|||
eIdentityComponents, |
|||
IdentityEntityActionContributors, |
|||
IdentityUserDto, |
|||
} from '@abp/ng.identity'; |
|||
import { EntityAction, EntityActionList } from '@abp/ng.theme.shared/extensions'; |
|||
|
|||
const alertUserName = new EntityAction<IdentityUserDto>({ |
|||
text: 'Click Me!', |
|||
action: data => { |
|||
// Replace alert with your custom code |
|||
alert(data.record.userName); |
|||
}, |
|||
// See EntityActionOptions in API section for all options |
|||
}); |
|||
|
|||
export function alertUserNameContributor(actionList: EntityActionList<IdentityUserDto>) { |
|||
actionList.addTail(alertUserName); |
|||
} |
|||
|
|||
export const identityEntityActionContributors: IdentityEntityActionContributors = { |
|||
// enum indicates the page to add contributors to |
|||
[eIdentityComponents.Users]: [ |
|||
alertUserNameContributor, |
|||
// You can add more contributors here |
|||
], |
|||
}; |
|||
``` |
|||
|
|||
The list of actions, conveniently named as `actionList`, is a **doubly linked list**. That is why we have used the `addTail` method, which adds the given value to the end of the list. You may find [all available methods here](../Common/Utils/Linked-List.md). |
|||
|
|||
### Step 2. Import and Use Entity Action Contributors |
|||
|
|||
Import `identityEntityActionContributors` in your routing module and pass it to the static `forLazy` method of `IdentityModule` as seen below: |
|||
|
|||
```js |
|||
// src/app/app-routing.module.ts |
|||
|
|||
// other imports |
|||
import { identityEntityActionContributors } from './entity-action-contributors'; |
|||
|
|||
const routes: Routes = [ |
|||
// other routes |
|||
|
|||
{ |
|||
path: 'identity', |
|||
loadChildren: () => |
|||
import('@abp/ng.identity').then(m => |
|||
m.IdentityModule.forLazy({ |
|||
entityActionContributors: identityEntityActionContributors, |
|||
}) |
|||
), |
|||
}, |
|||
|
|||
// other routes |
|||
]; |
|||
``` |
|||
|
|||
That is it, `alertUserName` entity action will be added as the last action on the grid dropdown in the "Users" page (`UsersComponent`) of the `IdentityModule`. |
|||
|
|||
## How to Place a Custom Modal and Trigger It by Entity Actions |
|||
|
|||
Let's employ dependency injection to extend the functionality of `IdentityModule` and add a quick view action for the User entity. We will take a lazy-loaded approach. |
|||
|
|||
<img alt="Entity Action Extension Example: Custom Modal" src="./images/entity-action-extensions---custom-modal.gif" width="800px" style="max-width:100%"> |
|||
|
|||
1. Create a folder at this path: `src/app/identity-extended` |
|||
|
|||
2. Add an entity action similar to this: |
|||
```js |
|||
// src/app/identity-extended/entity-action-contributors.ts |
|||
|
|||
import { |
|||
eIdentityComponents, |
|||
IdentityEntityActionContributors, |
|||
IdentityUserDto, |
|||
} from '@abp/ng.identity'; |
|||
import { EntityAction, EntityActionList } from '@abp/ng.theme.shared/extensions'; |
|||
import { IdentityExtendedComponent } from './identity-extended.component'; |
|||
|
|||
const quickViewAction = new EntityAction<IdentityUserDto>({ |
|||
text: 'Quick View', |
|||
action: data => { |
|||
const component = data.getInjected(IdentityExtendedComponent); |
|||
component.openUserQuickView(data.record); |
|||
}, |
|||
}); |
|||
|
|||
export function customModalContributor(actionList: EntityActionList<IdentityUserDto>) { |
|||
actionList.addTail(quickViewAction); |
|||
} |
|||
|
|||
export const identityEntityActionContributors: IdentityEntityActionContributors = { |
|||
// enum indicates the page to add contributors to |
|||
[eIdentityComponents.Users]: [ |
|||
customModalContributor, |
|||
// You can add more contributors here |
|||
], |
|||
}; |
|||
``` |
|||
|
|||
3. Create a parent component to the identity module. |
|||
```js |
|||
// src/app/identity-extended/identity-extended.component.ts |
|||
|
|||
import { IdentityUserDto } from '@abp/ng.identity'; |
|||
import { Component } from '@angular/core'; |
|||
|
|||
@Component({ |
|||
selector: 'app-identity-extended', |
|||
templateUrl: './identity-extended.component.html', |
|||
}) |
|||
export class IdentityExtendedComponent { |
|||
isUserQuickViewVisible: boolean; |
|||
|
|||
user: IdentityUserDto; |
|||
|
|||
openUserQuickView(record: IdentityUserDto) { |
|||
this.user = new Proxy(record, { |
|||
get: (target, prop) => target[prop] || '—', |
|||
}); |
|||
this.isUserQuickViewVisible = true; |
|||
} |
|||
} |
|||
``` |
|||
|
|||
4. Add a router outlet and a modal to the parent component. |
|||
```html |
|||
<!-- src/app/identity-extended/identity-extended.component.html --> |
|||
|
|||
<router-outlet></router-outlet> |
|||
|
|||
<abp-modal [(visible)]="isUserQuickViewVisible"> |
|||
<ng-template #abpHeader> |
|||
<h3>{%{{{ user.userName }}}%}</h3> |
|||
</ng-template> |
|||
|
|||
<ng-template #abpBody> |
|||
<table class="table table-borderless"> |
|||
<tbody> |
|||
<tr> |
|||
<th scope="row">{%{{{ 'AbpIdentity::DisplayName:Name' | abpLocalization }}}%}</th> |
|||
<td>{%{{{ user.name }}}%}</td> |
|||
</tr> |
|||
<tr> |
|||
<th scope="row">{%{{{ 'AbpIdentity::DisplayName:Surname' | abpLocalization }}}%}</th> |
|||
<td>{%{{{ user.surname }}}%}</td> |
|||
</tr> |
|||
<tr> |
|||
<th scope="row">{%{{{ 'AbpIdentity::EmailAddress' | abpLocalization }}}%}</th> |
|||
<td>{%{{{ user.email }}}%}</td> |
|||
</tr> |
|||
<tr> |
|||
<th scope="row">{%{{{ 'AbpIdentity::PhoneNumber' | abpLocalization }}}%}</th> |
|||
<td>{%{{{ user.phoneNumber }}}%}</td> |
|||
</tr> |
|||
</tbody> |
|||
</table> |
|||
</ng-template> |
|||
|
|||
<ng-template #abpFooter> |
|||
<button type="button" class="btn btn-secondary" #abpClose> |
|||
{%{{{ 'AbpUi::Close' | abpLocalization }}}%} |
|||
</button> |
|||
</ng-template> |
|||
</abp-modal> |
|||
``` |
|||
|
|||
5. Add a module for the component and load `IdentityModule` as seen below: |
|||
```js |
|||
// src/app/identity-extended/identity-extended.module.ts |
|||
|
|||
import { CoreModule } from '@abp/ng.core'; |
|||
import { IdentityModule } from '@abp/ng.identity'; |
|||
import { ThemeSharedModule } from '@abp/ng.theme.shared'; |
|||
import { NgModule } from '@angular/core'; |
|||
import { RouterModule } from '@angular/router'; |
|||
import { identityEntityActionContributors } from './entity-action-contributors'; |
|||
import { IdentityExtendedComponent } from './identity-extended.component'; |
|||
|
|||
@NgModule({ |
|||
imports: [ |
|||
CoreModule, |
|||
ThemeSharedModule, |
|||
RouterModule.forChild([ |
|||
{ |
|||
path: '', |
|||
component: IdentityExtendedComponent, |
|||
children: [ |
|||
{ |
|||
path: '', |
|||
loadChildren: () => |
|||
IdentityModule.forLazy({ |
|||
entityActionContributors: identityEntityActionContributors, |
|||
}), |
|||
}, |
|||
], |
|||
}, |
|||
]), |
|||
], |
|||
declarations: [IdentityExtendedComponent], |
|||
}) |
|||
export class IdentityExtendedModule {} |
|||
``` |
|||
|
|||
6. Load `IdentityExtendedModule` instead of `IdentityModule` in your root routing module. |
|||
```js |
|||
// src/app/app-routing.module.ts |
|||
|
|||
const routes: Routes = [ |
|||
// other routes |
|||
|
|||
{ |
|||
path: 'identity', |
|||
loadChildren: () => |
|||
import('./identity-extended/identity-extended.module') |
|||
.then(m => m.IdentityExtendedModule), |
|||
}, |
|||
|
|||
// other routes |
|||
]; |
|||
``` |
|||
|
|||
That's it. As you see, we reached the `IdentityExtendedComponent` through dependency injection and called one of its methods in our action. The specific user was also available via `data.record`, so we were able to display a summary view. |
|||
|
|||
## API |
|||
|
|||
### ActionData\<R = any\> |
|||
|
|||
`ActionData` is the shape of the parameter passed to all callbacks or predicates in an `EntityAction`. |
|||
|
|||
It has the following properties: |
|||
|
|||
- **record** is the row data, i.e. current value rendered in the table. |
|||
|
|||
```js |
|||
{ |
|||
text: 'Click Me!', |
|||
action: data => { |
|||
alert(data.record.userName); |
|||
}, |
|||
} |
|||
``` |
|||
|
|||
- **index** is the table index where the record is at. |
|||
|
|||
- **getInjected** is the equivalent of [Injector.get](https://angular.io/api/core/Injector#get). You can use it to reach injected dependencies of `GridActionsComponent`, including, but not limited to, its parent component. |
|||
|
|||
```js |
|||
{ |
|||
text: 'Click Me!', |
|||
action: data => { |
|||
const restService = data.getInjected(RestService); |
|||
|
|||
// Use restService public props and methods here |
|||
}, |
|||
visible: data => { |
|||
const usersComponent = data.getInjected(UsersComponent); |
|||
|
|||
// Use usersComponent public props and methods here |
|||
}, |
|||
} |
|||
``` |
|||
|
|||
### ActionCallback\<T, R = any\> |
|||
|
|||
`ActionCallback` is the type of the callback function that can be passed to an `EntityAction` as `action` parameter. An action callback gets a single parameter, the `ActionData`. The return type may be anything, including `void`. Here is a simplified representation: |
|||
|
|||
```js |
|||
type ActionCallback<T, R = any> = (data?: ActionData<T>) => R; |
|||
``` |
|||
|
|||
### ActionPredicate\<T\> |
|||
|
|||
`ActionPredicate` is the type of the predicate function that can be passed to an `EntityAction` as `visible` parameter. An action predicate gets a single parameter, the `ActionData`. The return type must be `boolean`. Here is a simplified representation: |
|||
|
|||
```js |
|||
type ActionPredicate<T> = (data?: ActionData<T>) => boolean; |
|||
``` |
|||
|
|||
### EntityActionOptions\<R = any\> |
|||
|
|||
`EntityActionOptions` is the type that defines required and optional properties you have to pass in order to create an entity action. |
|||
|
|||
Its type definition is as follows: |
|||
|
|||
```js |
|||
type EntityActionOptions<R = any> = { |
|||
action: ActionCallback<R>, |
|||
text: string, |
|||
icon?: string, |
|||
permission?: string, |
|||
visible?: ActionPredicate<R>, |
|||
}; |
|||
``` |
|||
|
|||
As you see, passing `action` and `text` is enough to create an entity action. Here is what each property is good for: |
|||
|
|||
- **action** is a callback that is called when the grid action is clicked. (_required_) |
|||
- **text** is the button text which will be localized. (_required_) |
|||
- **icon** is the classes that define an icon to be placed before the text. (_default:_ `''`) |
|||
- **permission** is the permission context which will be used to decide if this type of grid action should be displayed to the user or not. (_default:_ `undefined`) |
|||
- **visible** is a predicate that will be used to decide if the current record should have this grid action or not. (_default:_ `() => true`) |
|||
|
|||
You may find a full example below. |
|||
|
|||
### EntityAction\<R = any\> |
|||
|
|||
`EntityAction` is the class that defines your entity actions. It takes an `EntityActionOptions` and sets the default values to the properties, creating an entity action that can be passed to an entity contributor. |
|||
|
|||
```js |
|||
const options: EntityActionOptions<IdentityUserDto> = { |
|||
action: data => { |
|||
const component = data.getInjected(IdentityExtendedComponent); |
|||
component.unlock(data.record.id); |
|||
}, |
|||
text: 'AbpIdentity::Unlock', |
|||
icon: 'fa fa-unlock', |
|||
permission: 'AbpIdentity.Users.Update', |
|||
visible: data => data.record.isLockedOut, |
|||
}; |
|||
|
|||
const action = new EntityAction(options); |
|||
``` |
|||
|
|||
It also has two static methods to create its instances: |
|||
|
|||
- **EntityAction.create\<R = any\>\(options: EntityActionOptions\<R\>\)** is used to create an instance of `EntityAction`. |
|||
```js |
|||
const action = EntityAction.create(options); |
|||
``` |
|||
- **EntityAction.createMany\<R = any\>\(options: EntityActionOptions\<R\>\[\]\)** is used to create multiple instances of `EntityAction` with given array of `EntityActionOptions`. |
|||
```js |
|||
const actions = EntityAction.createMany(optionsArray); |
|||
``` |
|||
|
|||
### EntityActionList\<R = any\> |
|||
|
|||
`EntityActionList` is the list of actions passed to every action contributor callback as the first parameter named `actionList`. It is a **doubly linked list**. You may find [all available methods here](../Common/Utils/Linked-List.md). |
|||
|
|||
The items in the list will be displayed according to the linked list order, i.e. from head to tail. If you want to re-order them, all you have to do is something like this: |
|||
|
|||
```js |
|||
export function reorderUserContributors( |
|||
actionList: EntityActionList<IdentityUserDto>, |
|||
) { |
|||
// drop "Unlock" button |
|||
const unlockActionNode = actionList.dropByValue( |
|||
'AbpIdentity::Unlock', |
|||
(action, text) => action.text === text, |
|||
); |
|||
|
|||
// add it back to the head of the list |
|||
actionList.addHead(unlockActionNode.value); |
|||
} |
|||
``` |
|||
|
|||
### EntityActionContributorCallback\<R = any\> |
|||
|
|||
`EntityActionContributorCallback` is the type that you can pass as entity action contributor callbacks to static `forLazy` methods of the modules. |
|||
|
|||
```js |
|||
// lockUserContributor should have EntityActionContributorCallback<IdentityUserDto> type |
|||
|
|||
export function lockUserContributor( |
|||
actionList: EntityActionList<IdentityUserDto>, |
|||
) { |
|||
// add lockUser as 3rd action |
|||
actionList.add(lockUser).byIndex(2); |
|||
} |
|||
|
|||
export const identityEntityActionContributors = { |
|||
[eIdentityComponents.Users]: [lockUserContributor], |
|||
}; |
|||
``` |
|||
|
|||
## See Also |
|||
|
|||
- [Customizing Application Modules Guide](../../Customizing-Application-Modules-Guide.md) |
|||
@ -0,0 +1,402 @@ |
|||
# Page Toolbar Extensions for Angular UI |
|||
|
|||
## Introduction |
|||
|
|||
Page toolbar extension system allows you to add a new action to the toolbar of a page. A "Click Me" action was added to the user management page below: |
|||
|
|||
<img alt="Page Toolbar Extension Example: 'Click Me!' Action" src="./images/toolbar-action-extensions---click-me.gif" width="800px" style="max-width:100%"> |
|||
|
|||
You can take any action (open a modal, make an HTTP API call, redirect to another page... etc) by writing your custom code. You can also access to page data (the main record, usually an entity list) in your code. Additionally, you can pass in custom components instead of using the default button. |
|||
|
|||
## How to Add an Action to Page Toolbar |
|||
|
|||
In this example, we will add a "Click Me!" action and log `userName` of all users in the user management page of the [Identity Module](../../Modules/Identity.md) to the console. |
|||
|
|||
### Step 1. Create Toolbar Action Contributors |
|||
|
|||
The following code prepares a constant named `identityToolbarActionContributors`, ready to be imported and used in your root module: |
|||
|
|||
```js |
|||
// src/app/toolbar-action-contributors.ts |
|||
|
|||
import { |
|||
eIdentityComponents, |
|||
IdentityToolbarActionContributors, |
|||
IdentityUserDto, |
|||
} from '@abp/ng.identity'; |
|||
import { ToolbarAction, ToolbarActionList } from '@abp/ng.theme.shared/extensions'; |
|||
|
|||
const logUserNames = new ToolbarAction<IdentityUserDto[]>({ |
|||
text: 'Click Me!', |
|||
action: data => { |
|||
// Replace log with your custom code |
|||
data.record.forEach(user => console.log(user.userName)); |
|||
}, |
|||
// See ToolbarActionOptions in API section for all options |
|||
}); |
|||
|
|||
export function logUserNamesContributor(actionList: ToolbarActionList<IdentityUserDto[]>) { |
|||
actionList.addHead(logUserNames); |
|||
} |
|||
|
|||
export const identityToolbarActionContributors: IdentityToolbarActionContributors = { |
|||
// enum indicates the page to add contributors to |
|||
[eIdentityComponents.Users]: [ |
|||
logUserNamesContributor, |
|||
// You can add more contributors here |
|||
], |
|||
}; |
|||
|
|||
``` |
|||
|
|||
The list of actions, conveniently named as `actionList`, is a **doubly linked list**. That is why we have used the `addHead` method, which adds the given value to the beginning of the list. You may find [all available methods here](../Common/Utils/Linked-List.md). |
|||
|
|||
### Step 2. Import and Use Toolbar Action Contributors |
|||
|
|||
Import `identityToolbarActionContributors` in your routing module and pass it to the static `forLazy` method of `IdentityModule` as seen below: |
|||
|
|||
```js |
|||
// src/app/app-routing.module.ts |
|||
|
|||
// other imports |
|||
import { identityToolbarActionContributors } from './toolbar-action-contributors'; |
|||
|
|||
const routes: Routes = [ |
|||
// other routes |
|||
|
|||
{ |
|||
path: 'identity', |
|||
loadChildren: () => |
|||
import('@abp/ng.identity').then(m => |
|||
m.IdentityModule.forLazy({ |
|||
toolbarActionContributors: identityToolbarActionContributors, |
|||
}) |
|||
), |
|||
}, |
|||
|
|||
// other routes |
|||
]; |
|||
``` |
|||
|
|||
That is it, `logUserNames` toolbar action will be added as the first action on the page toolbar in the users page (`UsersComponent`) of the `IdentityModule`. |
|||
|
|||
## How to Add a Custom Component to Page Toolbar |
|||
|
|||
In this example, we will add a custom "Click Me!" button and log `userName` of all users in the user management page of the [Identity Module](../../Modules/Identity.md) to the console. |
|||
|
|||
<img alt="Page Toolbar Extension Example: Custom Component" src="./images/toolbar-action-extensions---custom-component.gif" width="800px" style="max-width:100%"> |
|||
|
|||
### Step 1. Create A Custom Component |
|||
|
|||
We need to have a component before we can pass it to the toolbar action contributors: |
|||
|
|||
```js |
|||
// src/app/click-me-button.component.ts |
|||
|
|||
import { IdentityUserDto } from '@abp/ng.identity'; |
|||
import { ActionData, EXTENSIONS_ACTION_DATA } from '@abp/ng.theme.shared/extensions'; |
|||
import { Component, Inject } from '@angular/core'; |
|||
|
|||
@Component({ |
|||
selector: 'app-click-me-button', |
|||
template: `<button class="btn btn-warning" (click)="handleClick()">Click Me!</button>`, |
|||
}) |
|||
export class ClickMeButtonComponent { |
|||
constructor( |
|||
@Inject(EXTENSIONS_ACTION_DATA) |
|||
private data: ActionData<IdentityUserDto[]> |
|||
) {} |
|||
|
|||
handleClick() { |
|||
this.data.record.forEach(user => console.log(user.userName)); |
|||
} |
|||
} |
|||
|
|||
``` |
|||
|
|||
Here, `EXTENSIONS_ACTION_DATA` token provides us the context from the page toolbar. Therefore, we are able to reach the page data via `record`, which is an array of users, i.e. `IdentityUserDto[]`. |
|||
|
|||
> We could also import `EXTENSIONS_ACTION_CALLBACK` from **@abp/ng.theme.shared/extensions** package, which is a higher order function that triggers the predefined `action` when called. It passes `ActionData` as the first parameter, so you do not have to pass it explicitly. In other words, `EXTENSIONS_ACTION_CALLBACK` can be called without any parameters and it will not fail. |
|||
|
|||
### Step 2. Create Toolbar Action Contributors |
|||
|
|||
The following code prepares a constant named `identityToolbarActionContributors`, ready to be imported and used in your root module. When `ToolbarComponent` is used instead of `ToolbarAction`, we can pass a component in: |
|||
|
|||
```js |
|||
// src/app/toolbar-action-contributors.ts |
|||
|
|||
import { |
|||
eIdentityComponents, |
|||
IdentityToolbarActionContributors, |
|||
IdentityUserDto, |
|||
} from '@abp/ng.identity'; |
|||
import { ToolbarActionList, ToolbarComponent } from '@abp/ng.theme.shared/extensions'; |
|||
import { ClickMeButtonComponent } from './click-me-button.component'; |
|||
|
|||
const logUserNames = new ToolbarComponent<IdentityUserDto[]>({ |
|||
component: ClickMeButtonComponent, |
|||
// See ToolbarActionOptions in API section for all options |
|||
}); |
|||
|
|||
export function logUserNamesContributor(actionList: ToolbarActionList<IdentityUserDto[]>) { |
|||
actionList.addHead(logUserNames); |
|||
} |
|||
|
|||
export const identityToolbarActionContributors: IdentityToolbarActionContributors = { |
|||
// enum indicates the page to add contributors to |
|||
[eIdentityComponents.Users]: [ |
|||
logUserNamesContributor, |
|||
// You can add more contributors here |
|||
], |
|||
}; |
|||
|
|||
``` |
|||
|
|||
The list of actions, conveniently named as `actionList`, is a **doubly linked list**. That is why we have used the `addHead` method, which adds the given value to the beginning of the list. You may find [all available methods here](../Common/Utils/Linked-List.md). |
|||
|
|||
### Step 3. Import and Use Toolbar Action Contributors |
|||
|
|||
Import `identityToolbarActionContributors` in your routing module and pass it to the static `forLazy` method of `IdentityModule` as seen below. |
|||
|
|||
```js |
|||
// src/app/app-routing.module.ts |
|||
|
|||
// other imports |
|||
import { identityToolbarActionContributors } from './toolbar-action-contributors'; |
|||
|
|||
const routes: Routes = [ |
|||
// other routes |
|||
|
|||
{ |
|||
path: 'identity', |
|||
loadChildren: () => |
|||
import('@abp/ng.identity').then(m => |
|||
m.IdentityModule.forLazy({ |
|||
toolbarActionContributors: identityToolbarActionContributors, |
|||
}) |
|||
), |
|||
}, |
|||
|
|||
// other routes |
|||
]; |
|||
``` |
|||
|
|||
That is it, `logUserNames` toolbar action will be added as the first action on the page toolbar in the users page (`UsersComponent`) of the `IdentityModule` and it will be triggered by a custom button, i.e. `ClickMeButtonComponent`. Please note that **component projection is not limited to buttons** and you may use other UI components. |
|||
|
|||
## How to Place a Custom Modal and Trigger It by Toolbar Actions |
|||
|
|||
Please check the same topic in [entity action extensions document](Entity-Action-Extensions.md) and replace entity action with a toolbar action. |
|||
|
|||
## API |
|||
|
|||
### ActionData\<R = any\> |
|||
|
|||
`ActionData` is the shape of the parameter passed to all callbacks or predicates in a `ToolbarAction`. |
|||
|
|||
It has the following properties: |
|||
|
|||
- **record** is the page data, the main record on a page, usually an entity list (e.g. list of users). |
|||
|
|||
```js |
|||
{ |
|||
text: 'Click Me!', |
|||
action: data => { |
|||
data.record.forEach(user => { |
|||
console.lof(user.userName); |
|||
}); |
|||
}, |
|||
} |
|||
``` |
|||
|
|||
- **getInjected** is the equivalent of [Injector.get](https://angular.io/api/core/Injector#get). You can use it to reach injected dependencies of `PageToolbarComponent`, including, but not limited to, its parent component. |
|||
|
|||
```js |
|||
{ |
|||
text: 'Click Me!', |
|||
action: data => { |
|||
const restService = data.getInjected(RestService); |
|||
|
|||
// Use restService public props and methods here |
|||
}, |
|||
visible: data => { |
|||
const usersComponent = data.getInjected(UsersComponent); |
|||
|
|||
// Use usersComponent public props and methods here |
|||
}, |
|||
} |
|||
``` |
|||
|
|||
### ActionCallback\<T, R = any\> |
|||
|
|||
`ActionCallback` is the type of the callback function that can be passed to a `ToolbarAction` as `action` parameter. An action callback gets a single parameter, the `ActionData`. The return type may be anything, including `void`. Here is a simplified representation: |
|||
|
|||
```js |
|||
type ActionCallback<T, R = any> = (data?: ActionData<T>) => R; |
|||
``` |
|||
|
|||
### ActionPredicate\<T\> |
|||
|
|||
`ActionPredicate` is the type of the predicate function that can be passed to a `ToolbarAction` as `visible` parameter. An action predicate gets a single parameter, the `ActionData`. The return type must be `boolean`. Here is a simplified representation: |
|||
|
|||
```js |
|||
type ActionPredicate<T> = (data?: ActionData<T>) => boolean; |
|||
``` |
|||
|
|||
### ToolbarActionOptions\<R = any\> |
|||
|
|||
`ToolbarActionOptions` is the type that defines required and optional properties you have to pass in order to create an toolbar action. |
|||
|
|||
Its type definition is as follows: |
|||
|
|||
```js |
|||
type ToolbarActionOptions<R = any> = { |
|||
action: ActionCallback<R>, |
|||
text: string, |
|||
icon?: string, |
|||
permission?: string, |
|||
visible?: ActionPredicate<R>, |
|||
}; |
|||
``` |
|||
|
|||
As you see, passing `action` and `text` is enough to create an toolbar action. Here is what each property is good for: |
|||
|
|||
- **action** is a callback that is called when the toolbar action is clicked. (_required_) |
|||
- **text** is the button text which will be localized. (_required_) |
|||
- **icon** is the classes that define an icon to be placed before the text. (_default:_ `''`) |
|||
- **permission** is the permission context which will be used to decide if this toolbar action should be displayed to the user or not. (_default:_ `undefined`) |
|||
- **visible** is a predicate that will be used to decide if the page toolbar should have this action or not. (_default:_ `() => true`) |
|||
|
|||
You may find a full example below. |
|||
|
|||
### ToolbarAction\<R = any\> |
|||
|
|||
`ToolbarAction` is the class that defines your toolbar actions. It takes an `ToolbarActionOptions` and sets the default values to the properties, creating an toolbar action that can be passed to an toolbar contributor. |
|||
|
|||
```js |
|||
const options: ToolbarActionOptions<IdentityUserDto[]> = { |
|||
action: data => { |
|||
const service = data.getInjected(MyCustomIdentityService); |
|||
const lockedUsers = data.record.filter(user => user.isLockedOut); |
|||
service.unlockAll(lockedUsers); |
|||
}, |
|||
text: 'MyProjectName::UnlockAll', |
|||
icon: 'fa fa-unlock', |
|||
permission: 'AbpIdentity.Users.Update', |
|||
visible: data => data.record.some(user => user.isLockedOut), |
|||
}; |
|||
|
|||
const action = new ToolbarAction(options); |
|||
``` |
|||
|
|||
It also has two static methods to create its instances: |
|||
|
|||
- **ToolbarAction.create\<R = any\>\(options: ToolbarActionOptions\<R\>\)** is used to create an instance of `ToolbarAction`. |
|||
```js |
|||
const action = ToolbarAction.create(options); |
|||
``` |
|||
- **ToolbarAction.createMany\<R = any\>\(options: ToolbarActionOptions\<R\>\[\]\)** is used to create multiple instances of `ToolbarAction` with given array of `ToolbarActionOptions`. |
|||
|
|||
### ToolbarComponentOptions\<R = any\> |
|||
|
|||
`ToolbarComponentOptions` is the type that defines required and optional properties you have to pass in order to create an toolbar component. |
|||
|
|||
Its type definition is as follows: |
|||
|
|||
```js |
|||
type ToolbarComponentOptions<R = any> = { |
|||
component: Type<any>, |
|||
action?: ActionCallback<R>, |
|||
permission?: string, |
|||
visible?: ActionPredicate<R>, |
|||
}; |
|||
``` |
|||
|
|||
As you see, passing `action` and `text` is enough to create an toolbar action. Here is what each property is good for: |
|||
|
|||
- **component** is the constructor of the component to be projected. (_required_) |
|||
- **action** is a predefined callback that you can reach in your component via `EXTENSIONS_ACTION_CALLBACK` token and trigger. (_optional_) |
|||
- **permission** is the permission context which will be used to decide if this toolbar action should be displayed to the user or not. (_default:_ `undefined`) |
|||
- **visible** is a predicate that will be used to decide if the page toolbar should have this action or not. (_default:_ `() => true`) |
|||
|
|||
You may find a full example below. |
|||
|
|||
### ToolbarComponent\<R = any\> |
|||
|
|||
`ToolbarComponent` is the class that defines toolbar actions which project a custom component. It takes an `ToolbarComponentOptions` and sets the default values to the properties, creating a toolbar action that can be passed to an toolbar contributor. |
|||
|
|||
```js |
|||
const options: ToolbarComponentOptions<IdentityUserDto[]> = { |
|||
component: UnlockAllButton, |
|||
action: data => { |
|||
const service = data.getInjected(MyCustomIdentityService); |
|||
const lockedUsers = data.record.filter(user => user.isLockedOut); |
|||
service.unlockAll(lockedUsers); |
|||
}, |
|||
permission: 'AbpIdentity.Users.Update', |
|||
visible: data => data.record.some(user => user.isLockedOut), |
|||
}; |
|||
|
|||
const action = new ToolbarComponent(options); |
|||
``` |
|||
|
|||
It also has two static methods to create its instances: |
|||
|
|||
- **ToolbarComponent.create\<R = any\>\(options: ToolbarComponentOptions\<R\>\)** is used to create an instance of `ToolbarComponent`. |
|||
```js |
|||
const action = ToolbarComponent.create(options); |
|||
``` |
|||
- **ToolbarComponent.createMany\<R = any\>\(options: ToolbarComponentOptions\<R\>\[\]\)** is used to create multiple instances of `ToolbarComponent` with given array of `ToolbarComponentOptions`. |
|||
```js |
|||
const actions = ToolbarComponent.createMany(optionsArray); |
|||
``` |
|||
|
|||
### ToolbarActionList\<R = any\> |
|||
|
|||
`ToolbarActionList` is the list of actions passed to every action contributor callback as the first parameter named `actionList`. It is a **doubly linked list**. You may find [all available methods here](../Common/Utils/Linked-List.md). |
|||
|
|||
The items in the list will be displayed according to the linked list order, i.e. from head to tail. If you want to re-order them, all you have to do is something like this: |
|||
|
|||
```js |
|||
export function reorderUserContributors( |
|||
actionList: ToolbarActionList<IdentityUserDto[]>, |
|||
) { |
|||
// drop "New User" button |
|||
const newUserActionNode = actionList.dropByValue( |
|||
'AbpIdentity::NewUser', |
|||
(action, text) => action['text'] === text, |
|||
); |
|||
|
|||
// add it back to the head of the list |
|||
actionList.addHead(newUserActionNode.value); |
|||
} |
|||
|
|||
export const identityEntityActionContributors = { |
|||
[eIdentityComponents.Users]: [ |
|||
logUserNamesContributor, |
|||
reorderUserContributors, |
|||
], |
|||
}; |
|||
``` |
|||
|
|||
### ToolbarActionContributorCallback\<R = any\> |
|||
|
|||
`ToolbarActionContributorCallback` is the type that you can pass as toolbar action contributor callbacks to static `forLazy` methods of the modules. |
|||
|
|||
```js |
|||
// exportUsersContributor should have ToolbarActionContributorCallback<IdentityUserDto[]> type |
|||
|
|||
export function exportUsersContributor( |
|||
actionList: ToolbarActionList<IdentityUserDto[]>, |
|||
) { |
|||
// add exportUsers just before the last action |
|||
actionList.add(exportUsers).byIndex(-1); |
|||
} |
|||
|
|||
export const identityEntityActionContributors = { |
|||
[eIdentityComponents.Users]: [exportUsersContributor], |
|||
}; |
|||
``` |
|||
|
|||
## See Also |
|||
|
|||
- [Customizing Application Modules Guide](../../Customizing-Application-Modules-Guide.md) |
|||
|
After Width: | Height: | Size: 158 KiB |
|
After Width: | Height: | Size: 372 KiB |
|
After Width: | Height: | Size: 554 KiB |
|
After Width: | Height: | Size: 526 KiB |
|
After Width: | Height: | Size: 490 KiB |
|
After Width: | Height: | Size: 102 KiB |
|
After Width: | Height: | Size: 105 KiB |
|
After Width: | Height: | Size: 139 KiB |
|
After Width: | Height: | Size: 104 KiB |
|
After Width: | Height: | Size: 96 KiB |
|
After Width: | Height: | Size: 151 KiB |
|
After Width: | Height: | Size: 80 KiB |
@ -0,0 +1,163 @@ |
|||
# Page Toolbar Extensions for ASP.NET Core UI |
|||
|
|||
Page toolbar system allows you to add components to the toolbar of any page. The page toolbar is the area right to the header of a page. A button ("Import users from excel") was added to the user management page below: |
|||
|
|||
 |
|||
|
|||
You can add any type of view component item to the page toolbar or modify existing items. |
|||
|
|||
## How to Set Up |
|||
|
|||
In this example, we will add an "Import users from excel" button and execute a JavaScript code for the user management page of the [Identity Module](../../Modules/Identity.md). |
|||
|
|||
### Add a New Button to the User Management Page |
|||
|
|||
Write the following code inside the `ConfigureServices` of your web module class: |
|||
|
|||
````csharp |
|||
Configure<AbpPageToolbarOptions>(options => |
|||
{ |
|||
options.Configure<Volo.Abp.Identity.Web.Pages.Identity.Users.IndexModel>(toolbar => |
|||
{ |
|||
toolbar.AddButton( |
|||
LocalizableString.Create<MyProjectNameResource>("ImportFromExcel"), |
|||
icon: "file-import", |
|||
id: "ImportUsersFromExcel", |
|||
type: AbpButtonType.Secondary |
|||
); |
|||
}); |
|||
}); |
|||
```` |
|||
|
|||
`AddButton` is a shortcut to simply add a button component. Note that you need to add the `ImportFromExcel` to your localization dictionary (json file) to localize the text. |
|||
|
|||
When you run the application, you will see the button added next to the current button list. There are some other parameters of the `AddButton` method (for example, use `order` to set the order of the button component relative to the other components). |
|||
|
|||
### Create a JavaScript File |
|||
|
|||
Now, we can go to the client side to handle click event of the new button. First, add a new JavaScript file to your solution. We added inside the `/Pages/Identity/Users` folder of the `.Web` project: |
|||
|
|||
 |
|||
|
|||
Here, the content of this JavaScript file: |
|||
|
|||
````js |
|||
$(function () { |
|||
$('#ImportUsersFromExcel').click(function (e) { |
|||
e.preventDefault(); |
|||
alert('TODO: import users from excel'); |
|||
}); |
|||
}); |
|||
```` |
|||
|
|||
In the `click` event, you can do anything you need to do. |
|||
|
|||
### Add the File to the User Management Page |
|||
|
|||
Then you need to add this JavaScript file to the user management page. You can take the power of the [Bundling & Minification system](Bundling-Minification.md). |
|||
|
|||
Write the following code inside the `ConfigureServices` of your module class: |
|||
|
|||
````csharp |
|||
Configure<AbpBundlingOptions>(options => |
|||
{ |
|||
options.ScriptBundles.Configure( |
|||
typeof(Volo.Abp.Identity.Web.Pages.Identity.Users.IndexModel).FullName, |
|||
bundleConfiguration => |
|||
{ |
|||
bundleConfiguration.AddFiles( |
|||
"/Pages/Identity/Users/my-user-extensions.js" |
|||
); |
|||
}); |
|||
}); |
|||
```` |
|||
|
|||
This configuration adds `my-user-extensions.js` to the user management page of the Identity Module. `typeof(Volo.Abp.Identity.Web.Pages.Identity.Users.IndexModel).FullName` is the name of the bundle in the user management page. This is a common convention used for all the ABP Commercial modules. |
|||
|
|||
## Advanced Use Cases |
|||
|
|||
While you typically want to add a button action to the page toolbar, it is possible to add any type of component. |
|||
|
|||
### Add View Component to a Page Toolbar |
|||
|
|||
First, create a new view component in your project: |
|||
|
|||
 |
|||
|
|||
For this example, we've created a `MyToolbarItem` view component under the `/Pages/Identity/Users/MyToolbarItem` folder. |
|||
|
|||
`MyToolbarItemViewComponent.cs` content: |
|||
|
|||
````csharp |
|||
public class MyToolbarItemViewComponent : AbpViewComponent |
|||
{ |
|||
public IViewComponentResult Invoke() |
|||
{ |
|||
return View("~/Pages/Identity/Users/MyToolbarItem/Default.cshtml"); |
|||
} |
|||
} |
|||
```` |
|||
|
|||
`Default.cshtml` content: |
|||
|
|||
````xml |
|||
<span> |
|||
<button type="button" class="btn btn-dark">CLICK ME</button> |
|||
</span> |
|||
```` |
|||
|
|||
* `.cshtml` file can contain any type of component(s). It is a typical view component. |
|||
* `MyToolbarItemViewComponent` can inject and use any service if you need. |
|||
|
|||
Then you can add the `MyToolbarItemViewComponent` to the user management page: |
|||
|
|||
````csharp |
|||
Configure<AbpPageToolbarOptions>(options => |
|||
{ |
|||
options.Configure<Volo.Abp.Identity.Web.Pages.Identity.Users.IndexModel>( |
|||
toolbar => |
|||
{ |
|||
toolbar.AddComponent<MyToolbarItemViewComponent>(); |
|||
} |
|||
); |
|||
}); |
|||
```` |
|||
|
|||
* If your component accepts arguments (in the `Invoke`/`InvokeAsync` method), you can pass them to the `AddComponent` method as an anonymous object. |
|||
|
|||
#### Permissions |
|||
|
|||
If your button/component should be available based on a [permission/policy](../../Authorization.md), you can pass the permission/policy name as the `requiredPolicyName` parameter to the `AddButton` and `AddComponent` methods. |
|||
|
|||
### Add a Page Toolbar Contributor |
|||
|
|||
If you perform advanced custom logic while adding an item to a page toolbar, you can create a class that implements the `IPageToolbarContributor` interface or inherits from the `PageToolbarContributor` class: |
|||
|
|||
````csharp |
|||
public class MyToolbarContributor : PageToolbarContributor |
|||
{ |
|||
public override Task ContributeAsync(PageToolbarContributionContext context) |
|||
{ |
|||
context.Items.Insert(0, new PageToolbarItem(typeof(MyToolbarItemViewComponent))); |
|||
|
|||
return Task.CompletedTask; |
|||
} |
|||
} |
|||
```` |
|||
|
|||
* You can use `context.ServiceProvider` to resolve dependencies if you need. |
|||
|
|||
Then add your class to the `Contributors` list: |
|||
|
|||
````csharp |
|||
Configure<AbpPageToolbarOptions>(options => |
|||
{ |
|||
options.Configure<Volo.Abp.Identity.Web.Pages.Identity.Users.IndexModel>( |
|||
toolbar => |
|||
{ |
|||
toolbar.Contributors.Add(new MyToolbarContributor()); |
|||
} |
|||
); |
|||
}); |
|||
```` |
|||
|
|||
@ -0,0 +1,3 @@ |
|||
# Blazor UI: Page Progress |
|||
|
|||
TODO |
|||
|
After Width: | Height: | Size: 44 KiB |
|
After Width: | Height: | Size: 34 KiB |
@ -0,0 +1,12 @@ |
|||
{ |
|||
"culture": "en-GB", |
|||
"texts": { |
|||
"GivenTenantIsNotAvailable": "Given tenant is not available: {0}", |
|||
"Tenant": "Tenant", |
|||
"Switch": "switch", |
|||
"Name": "Name", |
|||
"SwitchTenantHint": "Leave the name field blank to switch to the host side.", |
|||
"SwitchTenant": "Switch tenant", |
|||
"NotSelected": "Not selected" |
|||
} |
|||
} |
|||
@ -0,0 +1,52 @@ |
|||
using System; |
|||
using System.Net.Http; |
|||
using Microsoft.AspNetCore.Http; |
|||
using Microsoft.Extensions.Options; |
|||
using Volo.Abp.DependencyInjection; |
|||
using Volo.Abp.Uow; |
|||
|
|||
namespace Volo.Abp.AspNetCore.Uow |
|||
{ |
|||
public class AspNetCoreUnitOfWorkTransactionBehaviourProvider : IUnitOfWorkTransactionBehaviourProvider, ISingletonDependency |
|||
{ |
|||
private readonly IHttpContextAccessor _httpContextAccessor; |
|||
private readonly AspNetCoreUnitOfWorkTransactionBehaviourProviderOptions _options; |
|||
|
|||
public virtual bool? IsTransactional |
|||
{ |
|||
get |
|||
{ |
|||
var httpContext = _httpContextAccessor.HttpContext; |
|||
if (httpContext == null) |
|||
{ |
|||
return null; |
|||
} |
|||
|
|||
var currentUrl = httpContext.Request.Path.Value; |
|||
if (currentUrl != null) |
|||
{ |
|||
foreach (var url in _options.NonTransactionalUrls) |
|||
{ |
|||
if (currentUrl.StartsWith(url, StringComparison.OrdinalIgnoreCase)) |
|||
{ |
|||
return false; |
|||
} |
|||
} |
|||
} |
|||
|
|||
return !string.Equals( |
|||
httpContext.Request.Method, |
|||
HttpMethod.Get.Method, StringComparison.OrdinalIgnoreCase |
|||
); |
|||
} |
|||
} |
|||
|
|||
public AspNetCoreUnitOfWorkTransactionBehaviourProvider( |
|||
IHttpContextAccessor httpContextAccessor, |
|||
IOptions<AspNetCoreUnitOfWorkTransactionBehaviourProviderOptions> options) |
|||
{ |
|||
_httpContextAccessor = httpContextAccessor; |
|||
_options = options.Value; |
|||
} |
|||
} |
|||
} |
|||
@ -0,0 +1,17 @@ |
|||
using System.Collections.Generic; |
|||
|
|||
namespace Volo.Abp.AspNetCore.Uow |
|||
{ |
|||
public class AspNetCoreUnitOfWorkTransactionBehaviourProviderOptions |
|||
{ |
|||
public List<string> NonTransactionalUrls { get; } |
|||
|
|||
public AspNetCoreUnitOfWorkTransactionBehaviourProviderOptions() |
|||
{ |
|||
NonTransactionalUrls = new List<string> |
|||
{ |
|||
"/connect/" |
|||
}; |
|||
} |
|||
} |
|||
} |
|||
@ -0,0 +1,10 @@ |
|||
{ |
|||
"culture": "en-GB", |
|||
"texts": { |
|||
"Volo.Authorization:010001": "Authorisation failed! Given policy has not granted.", |
|||
"Volo.Authorization:010002": "Authorisation failed! Given policy has not granted: {PolicyName}", |
|||
"Volo.Authorization:010003": "Authorisation failed! Given policy has not granted for given resource: {ResourceName}", |
|||
"Volo.Authorization:010004": "Authorisation failed! Given requirement has not granted for given resource: {ResourceName}", |
|||
"Volo.Authorization:010005": "Authorisation failed! Given requirements has not granted for given resource: {ResourceName}" |
|||
} |
|||
} |
|||
@ -0,0 +1,34 @@ |
|||
using System; |
|||
using System.Linq; |
|||
using AutoMapper; |
|||
using AutoMapper.Internal; |
|||
using Microsoft.Extensions.DependencyInjection; |
|||
using Microsoft.Extensions.DependencyInjection.Extensions; |
|||
using Volo.Abp.DependencyInjection; |
|||
|
|||
namespace Volo.Abp.AutoMapper |
|||
{ |
|||
public class AbpAutoMapperConventionalRegistrar : ConventionalRegistrarBase |
|||
{ |
|||
protected readonly Type[] OpenTypes = { |
|||
typeof(IValueResolver<,,>), |
|||
typeof(IMemberValueResolver<,,,>), |
|||
typeof(ITypeConverter<,>), |
|||
typeof(IValueConverter<,>), |
|||
typeof(IMappingAction<,>) |
|||
}; |
|||
|
|||
public override void AddType(IServiceCollection services, Type type) |
|||
{ |
|||
if (IsConventionalRegistrationDisabled(type)) |
|||
{ |
|||
return; |
|||
} |
|||
|
|||
if (type.IsClass && !type.IsAbstract && OpenTypes.Any(type.ImplementsGenericInterface)) |
|||
{ |
|||
services.TryAddTransient(type); |
|||
} |
|||
} |
|||
} |
|||
} |
|||
@ -1,122 +0,0 @@ |
|||
// This software is part of the Autofac IoC container
|
|||
// Copyright © 2015 Autofac Contributors
|
|||
// https://autofac.org
|
|||
//
|
|||
// Permission is hereby granted, free of charge, to any person
|
|||
// obtaining a copy of this software and associated documentation
|
|||
// files (the "Software"), to deal in the Software without
|
|||
// restriction, including without limitation the rights to use,
|
|||
// copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|||
// copies of the Software, and to permit persons to whom the
|
|||
// Software is furnished to do so, subject to the following
|
|||
// conditions:
|
|||
//
|
|||
// The above copyright notice and this permission notice shall be
|
|||
// included in all copies or substantial portions of the Software.
|
|||
//
|
|||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|||
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|||
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|||
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|||
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|||
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|||
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|||
// OTHER DEALINGS IN THE SOFTWARE.
|
|||
|
|||
using System; |
|||
using Microsoft.Extensions.DependencyInjection; |
|||
|
|||
namespace Autofac.Extensions.DependencyInjection |
|||
{ |
|||
/// <summary>
|
|||
/// Autofac implementation of the ASP.NET Core <see cref="IServiceProvider"/>.
|
|||
/// </summary>
|
|||
/// <seealso cref="System.IServiceProvider" />
|
|||
/// <seealso cref="Microsoft.Extensions.DependencyInjection.ISupportRequiredService" />
|
|||
public class AutofacServiceProvider : IServiceProvider, ISupportRequiredService, IDisposable |
|||
{ |
|||
private readonly ILifetimeScope _lifetimeScope; |
|||
|
|||
private bool _disposed = false; |
|||
|
|||
/// <summary>
|
|||
/// Initializes a new instance of the <see cref="AutofacServiceProvider"/> class.
|
|||
/// </summary>
|
|||
/// <param name="lifetimeScope">
|
|||
/// The lifetime scope from which services will be resolved.
|
|||
/// </param>
|
|||
public AutofacServiceProvider(ILifetimeScope lifetimeScope) |
|||
{ |
|||
this._lifetimeScope = lifetimeScope; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets service of type <paramref name="serviceType" /> from the
|
|||
/// <see cref="AutofacServiceProvider" /> and requires it be present.
|
|||
/// </summary>
|
|||
/// <param name="serviceType">
|
|||
/// An object that specifies the type of service object to get.
|
|||
/// </param>
|
|||
/// <returns>
|
|||
/// A service object of type <paramref name="serviceType" />.
|
|||
/// </returns>
|
|||
/// <exception cref="Autofac.Core.Registration.ComponentNotRegisteredException">
|
|||
/// Thrown if the <paramref name="serviceType" /> isn't registered with the container.
|
|||
/// </exception>
|
|||
/// <exception cref="Autofac.Core.DependencyResolutionException">
|
|||
/// Thrown if the object can't be resolved from the container.
|
|||
/// </exception>
|
|||
public object GetRequiredService(Type serviceType) |
|||
{ |
|||
return this._lifetimeScope.Resolve(serviceType); |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets the service object of the specified type.
|
|||
/// </summary>
|
|||
/// <param name="serviceType">
|
|||
/// An object that specifies the type of service object to get.
|
|||
/// </param>
|
|||
/// <returns>
|
|||
/// A service object of type <paramref name="serviceType" />; or <see langword="null" />
|
|||
/// if there is no service object of type <paramref name="serviceType" />.
|
|||
/// </returns>
|
|||
public object GetService(Type serviceType) |
|||
{ |
|||
return this._lifetimeScope.ResolveOptional(serviceType); |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets the underlying instance of <see cref="ILifetimeScope" />.
|
|||
/// </summary>
|
|||
public ILifetimeScope LifetimeScope => _lifetimeScope; |
|||
|
|||
/// <summary>
|
|||
/// Releases unmanaged and - optionally - managed resources.
|
|||
/// </summary>
|
|||
/// <param name="disposing">
|
|||
/// <see langword="true" /> to release both managed and unmanaged resources;
|
|||
/// <see langword="false" /> to release only unmanaged resources.
|
|||
/// </param>
|
|||
protected virtual void Dispose(bool disposing) |
|||
{ |
|||
if (!this._disposed) |
|||
{ |
|||
this._disposed = true; |
|||
if (disposing) |
|||
{ |
|||
this._lifetimeScope.Dispose(); |
|||
} |
|||
} |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|||
/// </summary>
|
|||
public void Dispose() |
|||
{ |
|||
this.Dispose(true); |
|||
GC.SuppressFinalize(this); |
|||
} |
|||
} |
|||
} |
|||
@ -1,77 +0,0 @@ |
|||
// This software is part of the Autofac IoC container
|
|||
// Copyright © 2017 Autofac Contributors
|
|||
// http://autofac.org
|
|||
//
|
|||
// Permission is hereby granted, free of charge, to any person
|
|||
// obtaining a copy of this software and associated documentation
|
|||
// files (the "Software"), to deal in the Software without
|
|||
// restriction, including without limitation the rights to use,
|
|||
// copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|||
// copies of the Software, and to permit persons to whom the
|
|||
// Software is furnished to do so, subject to the following
|
|||
// conditions:
|
|||
//
|
|||
// The above copyright notice and this permission notice shall be
|
|||
// included in all copies or substantial portions of the Software.
|
|||
//
|
|||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|||
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|||
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|||
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|||
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|||
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|||
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|||
// OTHER DEALINGS IN THE SOFTWARE.
|
|||
|
|||
using System; |
|||
using Microsoft.Extensions.DependencyInjection; |
|||
|
|||
namespace Autofac.Extensions.DependencyInjection |
|||
{ |
|||
/// <summary>
|
|||
/// A factory for creating a <see cref="ContainerBuilder"/> and an <see cref="T:System.IServiceProvider" />.
|
|||
/// </summary>
|
|||
public class AutofacServiceProviderFactory : IServiceProviderFactory<ContainerBuilder> |
|||
{ |
|||
private readonly Action<ContainerBuilder> _configurationAction; |
|||
|
|||
/// <summary>
|
|||
/// Initializes a new instance of the <see cref="AutofacServiceProviderFactory"/> class.
|
|||
/// </summary>
|
|||
/// <param name="configurationAction">Action on a <see cref="ContainerBuilder"/> that adds component registrations to the container.</param>
|
|||
public AutofacServiceProviderFactory(Action<ContainerBuilder> configurationAction = null) |
|||
{ |
|||
_configurationAction = configurationAction ?? (builder => { }); |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Creates a container builder from an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
|||
/// </summary>
|
|||
/// <param name="services">The collection of services</param>
|
|||
/// <returns>A container builder that can be used to create an <see cref="T:System.IServiceProvider" />.</returns>
|
|||
public ContainerBuilder CreateBuilder(IServiceCollection services) |
|||
{ |
|||
var builder = new ContainerBuilder(); |
|||
|
|||
builder.Populate(services); |
|||
|
|||
_configurationAction(builder); |
|||
|
|||
return builder; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Creates an <see cref="T:System.IServiceProvider" /> from the container builder.
|
|||
/// </summary>
|
|||
/// <param name="containerBuilder">The container builder</param>
|
|||
/// <returns>An <see cref="T:System.IServiceProvider" /></returns>
|
|||
public IServiceProvider CreateServiceProvider(ContainerBuilder containerBuilder) |
|||
{ |
|||
if (containerBuilder == null) throw new ArgumentNullException(nameof(containerBuilder)); |
|||
|
|||
var container = containerBuilder.Build(); |
|||
|
|||
return new AutofacServiceProvider(container); |
|||
} |
|||
} |
|||
} |
|||
@ -1,67 +0,0 @@ |
|||
// This software is part of the Autofac IoC container
|
|||
// Copyright © 2015 Autofac Contributors
|
|||
// http://autofac.org
|
|||
//
|
|||
// Permission is hereby granted, free of charge, to any person
|
|||
// obtaining a copy of this software and associated documentation
|
|||
// files (the "Software"), to deal in the Software without
|
|||
// restriction, including without limitation the rights to use,
|
|||
// copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|||
// copies of the Software, and to permit persons to whom the
|
|||
// Software is furnished to do so, subject to the following
|
|||
// conditions:
|
|||
//
|
|||
// The above copyright notice and this permission notice shall be
|
|||
// included in all copies or substantial portions of the Software.
|
|||
//
|
|||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|||
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|||
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|||
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|||
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|||
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|||
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|||
// OTHER DEALINGS IN THE SOFTWARE.
|
|||
|
|||
using System; |
|||
using Microsoft.Extensions.DependencyInjection; |
|||
|
|||
namespace Autofac.Extensions.DependencyInjection |
|||
{ |
|||
/// <summary>
|
|||
/// Autofac implementation of the ASP.NET Core <see cref="IServiceScope"/>.
|
|||
/// </summary>
|
|||
/// <seealso cref="Microsoft.Extensions.DependencyInjection.IServiceScope" />
|
|||
internal class AutofacServiceScope : IServiceScope |
|||
{ |
|||
private readonly ILifetimeScope _lifetimeScope; |
|||
|
|||
/// <summary>
|
|||
/// Initializes a new instance of the <see cref="AutofacServiceScope"/> class.
|
|||
/// </summary>
|
|||
/// <param name="lifetimeScope">
|
|||
/// The lifetime scope from which services should be resolved for this service scope.
|
|||
/// </param>
|
|||
public AutofacServiceScope(ILifetimeScope lifetimeScope) |
|||
{ |
|||
this._lifetimeScope = lifetimeScope; |
|||
this.ServiceProvider = this._lifetimeScope.Resolve<IServiceProvider>(); |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets an <see cref="IServiceProvider" /> corresponding to this service scope.
|
|||
/// </summary>
|
|||
/// <value>
|
|||
/// An <see cref="IServiceProvider" /> that can be used to resolve dependencies from the scope.
|
|||
/// </value>
|
|||
public IServiceProvider ServiceProvider { get; } |
|||
|
|||
/// <summary>
|
|||
/// Disposes of the lifetime scope and resolved disposable services.
|
|||
/// </summary>
|
|||
public void Dispose() |
|||
{ |
|||
this._lifetimeScope.Dispose(); |
|||
} |
|||
} |
|||
} |
|||
@ -1,65 +0,0 @@ |
|||
// This software is part of the Autofac IoC container
|
|||
// Copyright © 2015 Autofac Contributors
|
|||
// http://autofac.org
|
|||
//
|
|||
// Permission is hereby granted, free of charge, to any person
|
|||
// obtaining a copy of this software and associated documentation
|
|||
// files (the "Software"), to deal in the Software without
|
|||
// restriction, including without limitation the rights to use,
|
|||
// copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|||
// copies of the Software, and to permit persons to whom the
|
|||
// Software is furnished to do so, subject to the following
|
|||
// conditions:
|
|||
//
|
|||
// The above copyright notice and this permission notice shall be
|
|||
// included in all copies or substantial portions of the Software.
|
|||
//
|
|||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|||
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|||
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|||
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|||
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|||
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|||
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|||
// OTHER DEALINGS IN THE SOFTWARE.
|
|||
|
|||
using System.Diagnostics.CodeAnalysis; |
|||
using Microsoft.Extensions.DependencyInjection; |
|||
|
|||
namespace Autofac.Extensions.DependencyInjection |
|||
{ |
|||
/// <summary>
|
|||
/// Autofac implementation of the ASP.NET Core <see cref="IServiceScopeFactory"/>.
|
|||
/// </summary>
|
|||
/// <seealso cref="Microsoft.Extensions.DependencyInjection.IServiceScopeFactory" />
|
|||
[SuppressMessage("Microsoft.ApiDesignGuidelines", "CA2213", Justification = "The creator of the root service lifetime scope is responsible for disposal.")] |
|||
internal class AutofacServiceScopeFactory : IServiceScopeFactory |
|||
{ |
|||
private readonly ILifetimeScope _lifetimeScope; |
|||
|
|||
/// <summary>
|
|||
/// Initializes a new instance of the <see cref="AutofacServiceScopeFactory"/> class.
|
|||
/// </summary>
|
|||
/// <param name="lifetimeScope">The lifetime scope.</param>
|
|||
public AutofacServiceScopeFactory(ILifetimeScope lifetimeScope) |
|||
{ |
|||
this._lifetimeScope = lifetimeScope; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Creates an <see cref="IServiceScope" /> which contains an
|
|||
/// <see cref="System.IServiceProvider" /> used to resolve dependencies within
|
|||
/// the scope.
|
|||
/// </summary>
|
|||
/// <returns>
|
|||
/// An <see cref="IServiceScope" /> controlling the lifetime of the scope. Once
|
|||
/// this is disposed, any scoped services that have been resolved
|
|||
/// from the <see cref="IServiceScope.ServiceProvider" />
|
|||
/// will also be disposed.
|
|||
/// </returns>
|
|||
public IServiceScope CreateScope() |
|||
{ |
|||
return new AutofacServiceScope(this._lifetimeScope.BeginLifetimeScope()); |
|||
} |
|||
} |
|||
} |
|||
@ -1,9 +0,0 @@ |
|||
{ |
|||
"profiles": { |
|||
"Volo.Abp.Cli": { |
|||
"commandName": "Project", |
|||
"commandLineArgs": "bundle --skip-version-check", |
|||
"workingDirectory": "C:\\Github\\volo\\abp\\templates\\app-pro\\aspnet-core\\src\\MyCompanyName.MyProjectName.Blazor" |
|||
} |
|||
} |
|||
} |
|||
@ -1,11 +1,19 @@ |
|||
using System.Data; |
|||
using System; |
|||
using System.Data; |
|||
using System.Threading.Tasks; |
|||
|
|||
namespace Volo.Abp.Domain.Repositories.Dapper |
|||
{ |
|||
public interface IDapperRepository |
|||
{ |
|||
[Obsolete("Use GetDbConnectionAsync method.")] |
|||
IDbConnection DbConnection { get; } |
|||
|
|||
Task<IDbConnection> GetDbConnectionAsync(); |
|||
|
|||
[Obsolete("Use GetDbTransactionAsync method.")] |
|||
IDbTransaction DbTransaction { get; } |
|||
|
|||
Task<IDbTransaction> GetDbTransactionAsync(); |
|||
} |
|||
} |
|||
} |
|||
|
|||
@ -1,10 +1,16 @@ |
|||
using JetBrains.Annotations; |
|||
using System; |
|||
using System.Threading.Tasks; |
|||
using JetBrains.Annotations; |
|||
|
|||
namespace Volo.Abp.Data |
|||
{ |
|||
public interface IConnectionStringResolver |
|||
{ |
|||
[NotNull] |
|||
[Obsolete("Use ResolveAsync method.")] |
|||
string Resolve(string connectionStringName = null); |
|||
|
|||
[NotNull] |
|||
Task<string> ResolveAsync(string connectionStringName = null); |
|||
} |
|||
} |
|||
|
|||
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue